diff --git a/Install/Archive/v1.1/SolidFire PowerShell Tools Release Notes v1.1.pdf b/Archive/v1.1/SolidFire PowerShell Tools Release Notes v1.1.pdf old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.1/SolidFire PowerShell Tools Release Notes v1.1.pdf rename to Archive/v1.1/SolidFire PowerShell Tools Release Notes v1.1.pdf diff --git a/Install/Archive/v1.1/SolidFire PowerShell Tools User Guide v1.1.pdf b/Archive/v1.1/SolidFire PowerShell Tools User Guide v1.1.pdf old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.1/SolidFire PowerShell Tools User Guide v1.1.pdf rename to Archive/v1.1/SolidFire PowerShell Tools User Guide v1.1.pdf diff --git a/Install/Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi b/Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi rename to Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi diff --git a/Install/Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi.md5 b/Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi.md5 old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi.md5 rename to Archive/v1.1/SolidFire_PowerShell_1_1_0_37-install.msi.md5 diff --git a/Install/Archive/v1.2.1.1/SolidFire PowerShell Tools Release Notes v1.2.1.1.pdf b/Archive/v1.2.1.1/SolidFire PowerShell Tools Release Notes v1.2.1.1.pdf old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.2.1.1/SolidFire PowerShell Tools Release Notes v1.2.1.1.pdf rename to Archive/v1.2.1.1/SolidFire PowerShell Tools Release Notes v1.2.1.1.pdf diff --git a/Install/Archive/v1.2.1.1/SolidFire PowerShell Tools User Guide_v1.2.pdf b/Archive/v1.2.1.1/SolidFire PowerShell Tools User Guide_v1.2.pdf old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.2.1.1/SolidFire PowerShell Tools User Guide_v1.2.pdf rename to Archive/v1.2.1.1/SolidFire PowerShell Tools User Guide_v1.2.pdf diff --git a/Install/Archive/v1.2/SolidFire PowerShell Tools Release Notes_v1.2.pdf b/Archive/v1.2/SolidFire PowerShell Tools Release Notes_v1.2.pdf similarity index 100% rename from Install/Archive/v1.2/SolidFire PowerShell Tools Release Notes_v1.2.pdf rename to Archive/v1.2/SolidFire PowerShell Tools Release Notes_v1.2.pdf diff --git a/Install/Archive/v1.2/SolidFire PowerShell Tools User Guide_v1.2.pdf b/Archive/v1.2/SolidFire PowerShell Tools User Guide_v1.2.pdf similarity index 100% rename from Install/Archive/v1.2/SolidFire PowerShell Tools User Guide_v1.2.pdf rename to Archive/v1.2/SolidFire PowerShell Tools User Guide_v1.2.pdf diff --git a/Install/Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi b/Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi similarity index 100% rename from Install/Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi rename to Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi diff --git a/Install/Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi.md5 b/Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi.md5 similarity index 100% rename from Install/Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi.md5 rename to Archive/v1.2/SolidFire_PowerShell_1_2_0_37-install.msi.md5 diff --git a/Install/Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_Release_Notes.pdf b/Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_Release_Notes.pdf old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_Release_Notes.pdf rename to Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_Release_Notes.pdf diff --git a/Install/Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_User_Guide.pdf b/Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_User_Guide.pdf old mode 100755 new mode 100644 similarity index 100% rename from Install/Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_User_Guide.pdf rename to Archive/v1.3.1.4/NetApp_SolidFire_PowerShell_Tools_v1_3_1_4_User_Guide.pdf diff --git a/Install/Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi b/Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi similarity index 100% rename from Install/Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi rename to Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi diff --git a/Install/Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi.md5 b/Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi.md5 similarity index 100% rename from Install/Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi.md5 rename to Archive/v1.3.1.4/SolidFire_PowerShell_1_3_1_4-install.msi.md5 diff --git a/Install/Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_Release_Notes_v1.3.pdf b/Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_Release_Notes_v1.3.pdf similarity index 100% rename from Install/Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_Release_Notes_v1.3.pdf rename to Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_Release_Notes_v1.3.pdf diff --git a/Install/Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_User_Guide_v1.3.pdf b/Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_User_Guide_v1.3.pdf similarity index 100% rename from Install/Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_User_Guide_v1.3.pdf rename to Archive/v1.3/NetApp_SolidFire_PowerShell_Tools_User_Guide_v1.3.pdf diff --git a/Install/Archive/v1.3/SolidFire_PowerShell_1_3_0_124-install.msi b/Archive/v1.3/SolidFire_PowerShell_1_3_0_124-install.msi similarity index 100% rename from Install/Archive/v1.3/SolidFire_PowerShell_1_3_0_124-install.msi rename to Archive/v1.3/SolidFire_PowerShell_1_3_0_124-install.msi diff --git a/Install/Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_Release_Notes.pdf b/Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_Release_Notes.pdf similarity index 100% rename from Install/Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_Release_Notes.pdf rename to Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_Release_Notes.pdf diff --git a/Install/Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_User_Guide.pdf b/Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_User_Guide.pdf similarity index 100% rename from Install/Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_User_Guide.pdf rename to Archive/v1.4/NetApp_SolidFire_PowerShell_Tools_v1.4_User_Guide.pdf diff --git a/Install/Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi b/Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi similarity index 100% rename from Install/Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi rename to Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi diff --git a/Install/Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi.md5 b/Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi.md5 similarity index 100% rename from Install/Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi.md5 rename to Archive/v1.4/SolidFire_PowerShell_1_4_0_98-install.msi.md5 diff --git a/Archive/v1.5.1/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf b/Archive/v1.5.1/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf new file mode 100644 index 0000000..3915aef Binary files /dev/null and b/Archive/v1.5.1/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf differ diff --git a/Archive/v1.5.1/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf b/Archive/v1.5.1/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf new file mode 100644 index 0000000..1704aa1 Binary files /dev/null and b/Archive/v1.5.1/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf differ diff --git a/Install/NetApp_SolidFire_PowerShell_Tools _v1.5_Release_Notes.pdf b/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 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/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 Archive/v1.5/NetApp_SolidFire_PowerShell_Tools_v1.5_User_Guide.pdf diff --git a/Install/SolidFire_PowerShell_1_5_0_119-install.msi b/Archive/v1.5/SolidFire_PowerShell_1_5_0_119-install.msi similarity index 100% rename from Install/SolidFire_PowerShell_1_5_0_119-install.msi rename to Archive/v1.5/SolidFire_PowerShell_1_5_0_119-install.msi diff --git a/Archive/v1.6/ElementPowerShell_1.6_ReleaseNotes.pdf b/Archive/v1.6/ElementPowerShell_1.6_ReleaseNotes.pdf new file mode 100644 index 0000000..20b645b Binary files /dev/null and b/Archive/v1.6/ElementPowerShell_1.6_ReleaseNotes.pdf differ diff --git a/Archive/v1.6/ElementPowerShell_1.6_UserGuide.pdf b/Archive/v1.6/ElementPowerShell_1.6_UserGuide.pdf new file mode 100644 index 0000000..a0646f3 Binary files /dev/null and b/Archive/v1.6/ElementPowerShell_1.6_UserGuide.pdf differ diff --git a/Archive/v1.7/NetApp_Element_PowerShell_Release_Notes_1.7.pdf b/Archive/v1.7/NetApp_Element_PowerShell_Release_Notes_1.7.pdf new file mode 100644 index 0000000..d522ace Binary files /dev/null and b/Archive/v1.7/NetApp_Element_PowerShell_Release_Notes_1.7.pdf differ diff --git a/Archive/v1.7/NetApp_Element_PowerShell_User_Guide_1.7.pdf b/Archive/v1.7/NetApp_Element_PowerShell_User_Guide_1.7.pdf new file mode 100644 index 0000000..5641e0c Binary files /dev/null and b/Archive/v1.7/NetApp_Element_PowerShell_User_Guide_1.7.pdf differ diff --git a/Install/readme.txt b/Install/readme.txt deleted file mode 100644 index 2e8a769..0000000 --- a/Install/readme.txt +++ /dev/null @@ -1,3 +0,0 @@ -This directory contains the installer, checksum, and documents needed to get started using the SolidFire PowerShell Tools. - -Also join us at http://developer.solidfire.com \ No newline at end of file diff --git a/README.md b/README.md index 95ecc9e..f1e9b70 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# SolidFire PowerShell Tools +# NetApp SolidFire PowerShell Tools -### Version 1.5 +### Version 12.3.0 -![logo](Install/product.png) +![logo](docs/product.png) ## Description @@ -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 | @@ -25,10 +19,9 @@ The SolidFire Powershell Module can be installed directly on multiple systems by | Windows | [Instructions](docs/windows/README.md) | | Mac | [Instructions](docs/mac/README.md) | | Linux (Ubuntu/Centos) | [Instructions](docs/linux/README.md) | -| Docker | [Instructions](docs/docker/README.md) | ## Release Notes -[Click here to download latest release notes](https://github.com/solidfire/PowerShell/blob/master/Install/NetApp_SolidFire_PowerShell_Tools_v1.5_Release_Notes.pdf) +[Click here to download latest release notes](docs/NetApp_Element_PowerShell_12.3_Release_Notes.pdf) -User guides are available for each system in the installation instruction pages. +[Click here to download User Guide Doc](docs/NetApp_Element_PowerShell_12.3_User_Guide.pdf) diff --git a/VMware/New-TenantOrCluster.ps1 b/VMware/New-TenantOrCluster.ps1 index 84dcfa9..5a928be 100644 --- a/VMware/New-TenantOrCluster.ps1 +++ b/VMware/New-TenantOrCluster.ps1 @@ -180,7 +180,7 @@ $volumes = $volnumbers | %{Get-SFVolume -Name ("$accountname-$_")} Write-Verbose "Creating the volume access group $($Cluster)" -If(!(Get-SFVolumeAccessGroup -VolumeAccessGroupName $Cluster -ErrorAction SilentlyContinue)){ +If(!(Get-SFVolumeAccessGroup -Name $Cluster -ErrorAction SilentlyContinue)){ New-SFVolumeAccessGroup -Name $Cluster -VolumeIDs $volumes.VolumeID @@ -262,4 +262,4 @@ Write-Verbose "Rescanning the HBAs to connect all datastores" $vmhosts | Get-VMhostStorage -RescanAllHba -RescanVMFs Write-Verbose "Rescan Complete" -} \ No newline at end of file +} diff --git a/docs/NetApp_Element_PowerShell_12.3_Release_Notes.pdf b/docs/NetApp_Element_PowerShell_12.3_Release_Notes.pdf new file mode 100644 index 0000000..cd4ad52 Binary files /dev/null and b/docs/NetApp_Element_PowerShell_12.3_Release_Notes.pdf differ diff --git a/docs/NetApp_Element_PowerShell_12.3_User_Guide.pdf b/docs/NetApp_Element_PowerShell_12.3_User_Guide.pdf new file mode 100644 index 0000000..1d24198 Binary files /dev/null and b/docs/NetApp_Element_PowerShell_12.3_User_Guide.pdf differ diff --git a/docs/docker/README.md b/docs/docker/README.md deleted file mode 100644 index deace7d..0000000 --- a/docs/docker/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# To install SolidFire Powershell as Docker container: - -![solidfire-powershell-logo](../../Install/product.png) ![docker-logo](docker-logo-small.png) - -### Prerequisite: - -You must have Docker engine installed and running on your host machine. [Install the latest docker engine](https://www.docker.com/products/overview) - -### Run the SolidFire Powershell Container: - -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 netapp/solidfire-powershell - -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 - -**ProTip:** -You can change the mounted directory for `/scripts` by modifying the left side of the ':'. Use " " when a space exists in the path. -Ex: `docker run -it -v "/Users//Documents/Github/":/scripts netapp/solidfire-powershell` diff --git a/docs/docker/create-posh-DEVELOP b/docs/docker/create-posh-DEVELOP deleted file mode 100644 index 4f88333..0000000 --- a/docs/docker/create-posh-DEVELOP +++ /dev/null @@ -1,61 +0,0 @@ -############################################################ -# Dockerfile to create SolidFire PowerShell Container -# From Jenkins DEVELOP branch -# Based on Ubuntu Image -############################################################ - -# Set the base image to use to Ubuntu -FROM ubuntu - -# Set the file maintainer (your name - the file's author) -MAINTAINER NetApp SolidFire Host Integrations - -# Add security to apt sources list -# RUN echo "deb http://security.ubuntu.com/ubuntu trusty-security main" >> /etc/apt/sources.list - -# Update the default application repository sources list -RUN apt-get update - -# Install sudo -RUN apt-get install sudo -y - -# Install WGET -RUN apt-get install wget -y - -# Install CURL -RUN apt-get install curl -y - -# Use a non-root account -# RUN useradd -ms /bin/bash posh -# USER posh -# WORKDIR /home/posh -# RUN whoami - -# Install Powershell dependencies -RUN sudo apt-get install libcurl3 libunwind8 libicu55 -y - -# Download Powershell for Ubuntu -RUN wget https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.13/powershell_6.0.0-alpha.13-1ubuntu1.16.04.1_amd64.deb - -# Install Powershell -RUN sudo dpkg -i powershell_6.0.0-alpha.13-1ubuntu1.16.04.1_amd64.deb -RUN sudo apt-get install -f - -# Install Powershell -# RUN curl -fsSL https://raw.githubusercontent.com/PowerShell/PowerShell/v6.0.0-alpha.13/tools/download.sh | bash -s - -# Setup Module Directory -RUN mkdir -p /usr/local/share/powershell/Modules/SolidFire - -# Download the SolidFire PowerShell module files -#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/SDK/job/solidfire-sdk-dotnet-DEVELOP/lastSuccessfulBuild/artifact/src/DotNetSdk/bin/Debug/netstandard1.6/DotNetSdk.dll - -#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/SDK/job/solidfire-sdk-dotnet-DEVELOP/lastSuccessfulBuild/artifact/src/DotNetSdk/bin/Debug/net46/Newtonsoft.Json.dll - -#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/PowerShell/job/PowerShell%20Build%20Develop/lastSuccessfulBuild/artifact/src/PowerShellModule/bin/Debug/netstandard1.6/SolidFire.dll - -#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/PowerShell/job/PowerShell%20Build%20Develop/lastSuccessfulBuild/artifact/src/PowerShellModule/SolidFire.psd1 - - -# Set the entrypoint to powershell command -ENTRYPOINT powershell diff --git a/docs/docker/docker-logo-small.png b/docs/docker/docker-logo-small.png deleted file mode 100644 index db6cf80..0000000 Binary files a/docs/docker/docker-logo-small.png and /dev/null differ diff --git a/docs/linux/README.md b/docs/linux/README.md index a19be88..0a2f650 100644 --- a/docs/linux/README.md +++ b/docs/linux/README.md @@ -1,6 +1,6 @@ -# Install SolidFire PowerShell on Linux +# Install NetApp SolidFire PowerShell Tools on Linux -![solidfire-powershell-logo](../../Install/product.png) ![linux-logo](linux-logo-small.png) +![solidfire-powershell-logo](../../docs/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. @@ -10,17 +10,19 @@ Follow the detailed instructions on the [PowerShell for Linux installation page] ## Next, Install SolidFire bits -1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: +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 + 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 + +**NOTE:** This module used to be called `SolidFire.Linux`. That name has been deprecated and it is now `SolidFire.Core` ## Paths diff --git a/docs/linux/linux12.3.md b/docs/linux/linux12.3.md new file mode 100644 index 0000000..aedd41a --- /dev/null +++ b/docs/linux/linux12.3.md @@ -0,0 +1,85 @@ +# Install NetApp SolidFire PowerShell Tools on Linux + +![solidfire-powershell-logo](../../docs/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 +###### CentOS +The following steps ran on CentOS 7.3. + +1. Install the rpm package: + + `#sudo rpm -Uvh https://packages.microsoft.com/config/centos/7/packages-microsoft-prod.rpm` + + Then install using yum: + + `#sudo yum install dotnet-sdk-3.1` + +2. Install PowerShell: + + `dotnet tool install --global PowerShell` + +###### Ubuntu +The Following process worked on Ubuntu Server 18.04. It should be similar with 16.04. + +1. Firstly you need to get the .NET Core SDK Package since the ubuntu package manger doesn’t have any prior knowledge of it. + The first this to do is download it using wget: + + `#wget -q https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb` + + +2. Next you need to install the downloaded package: + + `#sudo dpkg -i packages-microsoft-prod.deb` + + +3. Once that is done you can install the .NET Core SDK with the following commands: + + + `sudo add-apt-repository universe` + + `#sudo apt-get update` + + `#sudo apt-get install apt-transport-https` + + `#sudo apt-get update` + + `#sudo apt-get install dotnet-sdk-3.1` + +4. Install PowerShell: + + `dotnet tool install --global PowerShell` + +## 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 c5d3979..61512ff 100644 --- a/docs/mac/README.md +++ b/docs/mac/README.md @@ -1,6 +1,6 @@ -# 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) +![solidfire-powershell-logo](../../docs/product.png) ![apple-logo](apple-logo-small.png) ## Installation Instructions @@ -14,15 +14,15 @@ Follow the detailed instructions on the [PowerShell for Mac installation page](h 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/mac/Readme12.3.md b/docs/mac/Readme12.3.md new file mode 100644 index 0000000..61512ff --- /dev/null +++ b/docs/mac/Readme12.3.md @@ -0,0 +1,45 @@ +# Install NetApp SolidFire PowerShell Tools on Mac OS + +![solidfire-powershell-logo](../../docs/product.png) ![apple-logo](apple-logo-small.png) + +## Installation Instructions + +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 Mac installation page](https://github.com/PowerShell/PowerShell/blob/master/docs/installation/linux.md#macos-1012). + +### Next, Install SolidFire bits + +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 + +## 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. + +`$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/Install/product.png b/docs/product.png similarity index 100% rename from Install/product.png rename to docs/product.png diff --git a/docs/readme.txt b/docs/readme.txt new file mode 100644 index 0000000..32592ef --- /dev/null +++ b/docs/readme.txt @@ -0,0 +1,3 @@ +This directory contains the documents needed to get started using the SolidFire PowerShell Tools. + +Also join us at http://developer.solidfire.com \ No newline at end of file diff --git a/docs/windows/PowerShell12.3.md b/docs/windows/PowerShell12.3.md new file mode 100644 index 0000000..22e4a1b --- /dev/null +++ b/docs/windows/PowerShell12.3.md @@ -0,0 +1,49 @@ +# To install NetApp SolidFire Powershell on Windows: + +![solidfire-powershell-logo](../../docs/product.png) ![windows-logo](windows10-logo-small.png) + +This page has instructions for installing the SolidFire PowerShell Core tools module on a Windows client. + +**Note**: Only Powershell Core is supported in Powershell Tools v12.3. + +## Powershell Core + +##### Prerequisites + +| Component | Version | +|----------------------|------------------| +| PowerShell Core | 6.1 or later | +| SolidFire Element OS | 11.0 through 12.3| + +### Installation Instructions +1. Download and install the PowerShell Core msi installer: + + Latest version : [Powershell Core 7.1](https://github.com/PowerShell/PowerShell/) + +2. Download the PowerShell Core zip file from the NetApp Support Site and extract the contents to the directory you wish to keep them in. + +3. Open Windows PowerShell, or a command prompt, and run powershell core using the following command: + + pwsh + +4. Then, import the SolidFire module with the following command: + + PS> Import-Module \SolidFire.dll + +5. To see a list of available commands, use: + + PS> Get-Command -Module SolidFire + +##### 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 | +| Windows Server 2018 | +| Windows 10 | + +PowerShell Core 7.1 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 7.1](https://devblogs.microsoft.com/powershell/announcing-powershell-7-1/). diff --git a/docs/windows/README.md b/docs/windows/README.md index 7489a47..c0848b0 100644 --- a/docs/windows/README.md +++ b/docs/windows/README.md @@ -1,32 +1,43 @@ -# 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](../../docs/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 +## Powershell 6.1 + +##### Prerequisites | Component | Version | |----------------------|------------------| -| PowerShell | 4.0 or later | -| SolidFire Element OS | 7 through 10.0 | -| .NET Framework | 4.5.1 or later | +| PowerShell | 6.1 or later | +| SolidFire Element OS | 11.0 through 12.3| + +### Installation Instructions + +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](https://powershellgallery.com) with the following command: -## Installation Instructions + PS> Install-Module -Name SolidFire.Core -Download and launch the installer .msi file then follow the instructions in the install wizard. +1. Then, import the SolidFire module with the following command: -[SolidFire PowerShell Installer](https://github.com/solidfire/PowerShell/raw/master/Install/SolidFire_PowerShell_1_4_0_98-install.msi) + PS> Import-Module SolidFire.Core -** 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) +1. To see a list of available commands, use: -## Supported Microsoft Operating Systems + PS> Get-Command -Module SolidFire.Core -The following versions of Microsoft operating systems are supported and can run the SolidFire PowerShell tools. +##### 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 | -| Windows Server 2012 R2 | -| Windows 10 | +| Mac 10.13 | +| CentOS 7.3 | +| Ubuntu 16.04 | + +PowerShell 7.1 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 7.1](https://devblogs.microsoft.com/powershell/announcing-powershell-7-1/). 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 diff --git a/packages/Initialize-SFEnvironment.ps1 b/packages/Initialize-SFEnvironment.ps1 index 7256a6a..37451f6 100644 --- a/packages/Initialize-SFEnvironment.ps1 +++ b/packages/Initialize-SFEnvironment.ps1 @@ -1,5 +1,5 @@ <# -# Copyright © 2014-2017 NetApp, Inc. All Rights Reserved. +# Copyright © 2014-2021 NetApp, Inc. All Rights Reserved. # # CONFIDENTIALITY NOTICE: THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION OF # NETAPP, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR @@ -7,9 +7,9 @@ #> # Launch text -import-module SolidFire +Import-Module .\SolidFire.Core.psd1 -$version = (Get-Module SolidFire).Version[0] +$version = (Get-Module SolidFire.Core).Version[0] $host.ui.RawUI.WindowTitle ="SolidFire PowerShell Tools $version" @@ -50,8 +50,8 @@ Write-Host " =77777= =77777= Write-Host " =777= =777= " Write-Host " =777= =777=" Write-Host " " -write-host " Welcome to SolidFire PowerShell Tools" -foregroundcolor blue -Write-Host " Version $version " -foregroundcolor blue +write-host " Welcome to SolidFire PowerShell Tools " -foregroundcolor blue +Write-Host " Version $version " -foregroundcolor blue Write-Host "" write-host " To log into a SolidFire Cluster or Node: " -NoNewLine write-host "Connect-SFCluster" -foregroundcolor blue @@ -60,8 +60,8 @@ write-host "Get-SFCommand" -foregroundcolor blue write-host " To get help for SolidFire commands use: " -NoNewline write-host "Get-Help " -foregroundcolor blue write-host "" -write-host " Copyright © 2015 - 2017 NetApp, Inc. All Rights Reserved." +write-host " Copyright © 2014 - 2021 NetApp, Inc. All Rights Reserved." function global:Get-SFCommand([string] $Name = "*") { - get-command -Module SolidFire -Name $Name + get-command -Module SolidFire.Core -Name $Name } diff --git a/packages/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.dll deleted file mode 100644 index be6558d..0000000 Binary files a/packages/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/SolidFire.Core.psd1 b/packages/SolidFire.Core.psd1 new file mode 100644 index 0000000..bf55158 --- /dev/null +++ b/packages/SolidFire.Core.psd1 @@ -0,0 +1,267 @@ +# +# Module manifest for module 'SolidFire.Core' +# +# Generated by: SolidFire Host Integrations +# +# Generated on: 4/19/2021 +# + +@{ + +# Script module or binary module file associated with this manifest. +# RootModule = '' + +# Version number of this module. +ModuleVersion = '12.3.0.81' + +# Supported PSEditions +# CompatiblePSEditions = @() + +# ID used to uniquely identify this module +GUID = '08c9f606-5cc2-4552-8bda-89070155304e' + +# Author of this module +Author = 'SolidFire Host Integrations' + +# Company or vendor of this module +CompanyName = 'NetApp, Inc.' + +# Copyright statement for this module +Copyright = 'Copyright © 2014-2021 NetApp, Inc. All Rights Reserved.' + +# Description of the functionality provided by this module +Description = 'Dotnet Core version. The SolidFire PowerShell Tools is a collection of Microsoft® Windows® PowerShell functions that use SolidFire API to control a SolidFire storage system.' + +# Minimum version of the PowerShell engine required by this module +PowerShellVersion = '6.1.0' + +# Name of the PowerShell host required by this module +# PowerShellHostName = '' + +# Minimum version of the PowerShell host required by this module +# PowerShellHostVersion = '' + +# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# DotNetFrameworkVersion = '' + +# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. +# CLRVersion = '' + +# Processor architecture (None, X86, Amd64) required by this module +# ProcessorArchitecture = '' + +# Modules that must be imported into the global environment prior to importing this module +# RequiredModules = @() + +# Assemblies that must be loaded prior to importing this module +# RequiredAssemblies = @() + +# Script files (.ps1) that are run in the caller's environment prior to importing this module. +# ScriptsToProcess = @() + +# Type files (.ps1xml) to be loaded when importing this module +# TypesToProcess = @() + +# Format files (.ps1xml) to be loaded when importing this module +# FormatsToProcess = @() + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +NestedModules = @('SolidFire.dll') + +# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. +FunctionsToExport = '*' + +# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. +CmdletsToExport = '*' + +# Variables to export from this module +VariablesToExport = '*' + +# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. +AliasesToExport = '*' + +# DSC resources to export from this module +# DscResourcesToExport = @() + +# List of all modules packaged with this module +# ModuleList = @() + +# List of all files packaged with this module +# FileList = @() + +# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. +PrivateData = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + # Tags = @() + + # A URL to the license for this module. + LicenseUri = 'https://github.com/solidfire/PowerShell' + + # A URL to the main website for this project. + ProjectUri = 'https://github.com/solidfire/PowerShell' + + # A URL to an icon representing this module. + # IconUri = '' + + # ReleaseNotes of this module + # ReleaseNotes = '' + + } # End of PSData hashtable + +} # End of PrivateData hashtable + +# HelpInfo URI of this module +# HelpInfoURI = '' + +# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. +# DefaultCommandPrefix = '' + +} + + +# SIG # Begin signature block +# MIIaPQYJKoZIhvcNAQcCoIIaLjCCGioCAQExDzANBglghkgBZQMEAgEFADB5Bgor +# BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG +# KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCD4B1wbcFAXwPTr +# rbvZmK8GMji/cYE7J9Tiu8s+eRxep6CCFK4wggUAMIID6KADAgECAgEHMA0GCSqG +# SIb3DQEBCwUAMIGPMQswCQYDVQQGEwJVUzEQMA4GA1UECBMHQXJpem9uYTETMBEG +# A1UEBxMKU2NvdHRzZGFsZTElMCMGA1UEChMcU3RhcmZpZWxkIFRlY2hub2xvZ2ll +# cywgSW5jLjEyMDAGA1UEAxMpU3RhcmZpZWxkIFJvb3QgQ2VydGlmaWNhdGUgQXV0 +# aG9yaXR5IC0gRzIwHhcNMTEwNTAzMDcwMDAwWhcNMzEwNTAzMDcwMDAwWjCBxjEL +# MAkGA1UEBhMCVVMxEDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2Rh +# bGUxJTAjBgNVBAoTHFN0YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4xMzAxBgNV +# BAsTKmh0dHA6Ly9jZXJ0cy5zdGFyZmllbGR0ZWNoLmNvbS9yZXBvc2l0b3J5LzE0 +# MDIGA1UEAxMrU3RhcmZpZWxkIFNlY3VyZSBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkg +# LSBHMjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOWQZkvs+UZxqSCD +# vulsv0rJSGmBdU5tJPbLFxP4sHFZhHprK4WkNLUW5cvM6UFwLKQu1voyfeGo3pQQ +# rDHBwNhq/1knq3bW/At0a7inrj/EVPS0MUTdk1aMpExem4nLJIOb4ld9t9gSH8mF +# bfTRgPFQm4eu1AsQBfsnuihtF+kO1k25OVUG/wokBX4vxh1ybNSLKYxXfdrZ62Ya +# 00+n339SxDDFpckOAsVTv3c4aAYkw2bIN34wHkVxIzX/kNgqnY3nsJJNPH8qCpPc +# zRZGZfdghIt2S5EncxSS4OrujxbqjQ4+dhe/fYmAgERD5y3gQwl12jborduJOvVd +# Eo4jBIMCAwEAAaOCASwwggEoMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQD +# AgEGMB0GA1UdDgQWBBQlRYFoUCY4PTstLL7Natm2PbNmYzAfBgNVHSMEGDAWgBR8 +# DDIfp9kwf8R9aKNiqKHOqwdbJzA6BggrBgEFBQcBAQQuMCwwKgYIKwYBBQUHMAGG +# Hmh0dHA6Ly9vY3NwLnN0YXJmaWVsZHRlY2guY29tLzA7BgNVHR8ENDAyMDCgLqAs +# hipodHRwOi8vY3JsLnN0YXJmaWVsZHRlY2guY29tL3Nmcm9vdC1nMi5jcmwwTAYD +# VR0gBEUwQzBBBgRVHSAAMDkwNwYIKwYBBQUHAgEWK2h0dHBzOi8vY2VydHMuc3Rh +# cmZpZWxkdGVjaC5jb20vcmVwb3NpdG9yeS8wDQYJKoZIhvcNAQELBQADggEBAFZl +# yv7zPwqok4sYx95DaRM0IL5OX3ioa5zbak1B28ET7NwxACJe9wCeDOA0ZTT5sTpO +# SMgSgYhcWz4IU3r3GmTfuFBhzFNRQClLwvSuOl/kyq0mzE5hQ+X9V6Y3cM5DK7CU +# w5Lp4V+qEEm3aeTg0B9kpCvNH2+g+IQkGM55PamRv1QYE4mZVBENVcUmC3lPWhxu +# +WPbFICkB6v6sqW5iN2R/mU7pKN5volN4dCw9MgXDAqWFHwJt2zhwthV1BigqkFp +# cCSjue/pWtw+65RK8LfeXw52+vv7aQNFQFDucgykEoaBzRPRTsQ8yk4N0ibxALe0 +# pqLhbnqB/TCseh/HWXswggUFMIID7aADAgECAhEAtTPllraQMEYAAAAAVWavIzAN +# BgkqhkiG9w0BAQsFADCBtDELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUVudHJ1c3Qs +# IEluYy4xKDAmBgNVBAsTH1NlZSB3d3cuZW50cnVzdC5uZXQvbGVnYWwtdGVybXMx +# OTA3BgNVBAsTMChjKSAyMDE1IEVudHJ1c3QsIEluYy4gLSBmb3IgYXV0aG9yaXpl +# ZCB1c2Ugb25seTEoMCYGA1UEAxMfRW50cnVzdCBDb2RlIFNpZ25pbmcgQ0EgLSBP +# VkNTMTAeFw0xOTEyMTAyMTEwMDNaFw0yMjEyMTAyMTM5NThaMGIxCzAJBgNVBAYT +# AlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRIwEAYDVQQHEwlTdW5ueXZhbGUxFDAS +# BgNVBAoTC05ldEFwcCwgSW5jMRQwEgYDVQQDEwtOZXRBcHAsIEluYzCCASIwDQYJ +# KoZIhvcNAQEBBQADggEPADCCAQoCggEBANNKwgTpPGZmLfM4OBFeooro5VmDHx/4 +# WvgmU94LAwQPxt5t1HrCqiMGEipIkPYh5mlTNmDiy6yVzJ7uOXIIMKY3Nmtk99LA +# RzNcCWnGi9jf8ATuhXQWomy8ZcVHBjzbMBkDILi3BhibJI4z023r5A0zglEo0wlA +# NbAWDWeUHJcTHT2lW3Le7oun53PCYmJsCs7cIZzuAUChutC2NrXMrVMSOvizh4yb +# XR1kbvDF6LSx17/gmvuUzzy0ctHIhFxS+sXLW5+/uSr0Tx5naRwcBT/r+VJT0skb +# w1reTe/iwytrI65n9r0tMyoGhr/+wvC/VEyWOQ9UUM0gibXPcIJdTvECAwEAAaOC +# AWEwggFdMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzBqBggr +# BgEFBQcBAQReMFwwIwYIKwYBBQUHMAGGF2h0dHA6Ly9vY3NwLmVudHJ1c3QubmV0 +# MDUGCCsGAQUFBzAChilodHRwOi8vYWlhLmVudHJ1c3QubmV0L292Y3MxLWNoYWlu +# MjU2LmNlcjAxBgNVHR8EKjAoMCagJKAihiBodHRwOi8vY3JsLmVudHJ1c3QubmV0 +# L292Y3MxLmNybDBMBgNVHSAERTBDMDcGCmCGSAGG+mwKAQMwKTAnBggrBgEFBQcC +# ARYbaHR0cDovL3d3dy5lbnRydXN0Lm5ldC9ycGEgMAgGBmeBDAEEATAfBgNVHSME +# GDAWgBR+Gh8aEXRcZMkMH5QBq/2BZC6hLDAdBgNVHQ4EFgQUzKXl3rkIszKGmBpY +# osvi7kmtWN0wCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAxYwfFtS5tDJl +# Ca6IjWT/K2H1ypI3vTZPM75ZRp7udW1sWk/XtlF85xZLY5FYOClykuoewkyu7UsA +# fwUaxPab7qUCr1TD7O7x81Bzcfraq29RohT0TxgetZ+Mk8q4/mcAIsUM0l09jE59 +# XHzFfljnLLNka2FFr4mfCRKjw/gkAPkxzKvx5+miGY7hkQYTG77B+1Gj8HMA4Z0A +# t2dWFnn2oa0xnzqXlKaDZmTuCApYCo8seRNaNHzh3d93/HQ+Za6I1c5IcApcnv+9 +# 3eQjYn+sOEyi/bYcUXQ5tLX5UsxBSlYrvcbGWnXmPE0jo8eWohIct3QwQ+81bSsS +# WdVO7qH7qDCCBR0wggQFoAMCAQICDEPBCxwAAAAAUdNz2jANBgkqhkiG9w0BAQsF +# ADCBvjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUVudHJ1c3QsIEluYy4xKDAmBgNV +# BAsTH1NlZSB3d3cuZW50cnVzdC5uZXQvbGVnYWwtdGVybXMxOTA3BgNVBAsTMChj +# KSAyMDA5IEVudHJ1c3QsIEluYy4gLSBmb3IgYXV0aG9yaXplZCB1c2Ugb25seTEy +# MDAGA1UEAxMpRW50cnVzdCBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IC0g +# RzIwHhcNMTUwNjEwMTM0NjA1WhcNMzAxMTEwMTQxNjA1WjCBtDELMAkGA1UEBhMC +# VVMxFjAUBgNVBAoTDUVudHJ1c3QsIEluYy4xKDAmBgNVBAsTH1NlZSB3d3cuZW50 +# cnVzdC5uZXQvbGVnYWwtdGVybXMxOTA3BgNVBAsTMChjKSAyMDE1IEVudHJ1c3Qs +# IEluYy4gLSBmb3IgYXV0aG9yaXplZCB1c2Ugb25seTEoMCYGA1UEAxMfRW50cnVz +# dCBDb2RlIFNpZ25pbmcgQ0EgLSBPVkNTMTCCASIwDQYJKoZIhvcNAQEBBQADggEP +# ADCCAQoCggEBANiGDaBkCmr1jpa6O5poattEQN71LfzrbURYz45yw3AtXlrU+QvY +# ETWXwCnxO+4XodZEub8fSpjgGQ6141kIHVKMoLCKKEGkoYZAULNNx4hB2jaTp0w9 +# YywDy6+NACURaVAi9ksAzsOyLoGF3SPdTk218MCodPzrbGApmHGPaPe3HfP4Q4ti +# lTKGT8rITEtT/lEgMB7/AETHXnGapRuJdEr+Uz6E6rGjiZ34LUJY2AoGUCNwFhwC +# d5cYPNkQfQx65gUsGggWZhI4bHEd1mTXVsCNNsO4tQC43S+1er+xpG54+m0SduSZ +# dxGmJOSCuUZ5qbCjSVvTU3RDgXRvofguLyUCAwEAAaOCASEwggEdMA4GA1UdDwEB +# /wQEAwIBBjATBgNVHSUEDDAKBggrBgEFBQcDAzASBgNVHRMBAf8ECDAGAQH/AgEA +# MDMGCCsGAQUFBwEBBCcwJTAjBggrBgEFBQcwAYYXaHR0cDovL29jc3AuZW50cnVz +# dC5uZXQwMAYDVR0fBCkwJzAloCOgIYYfaHR0cDovL2NybC5lbnRydXN0Lm5ldC9n +# MmNhLmNybDA7BgNVHSAENDAyMDAGBFUdIAAwKDAmBggrBgEFBQcCARYaaHR0cDov +# L3d3dy5lbnRydXN0Lm5ldC9ycGEwHQYDVR0OBBYEFH4aHxoRdFxkyQwflAGr/YFk +# LqEsMB8GA1UdIwQYMBaAFGpyJnrQHu995ztpUdRsjZ+QEmarMA0GCSqGSIb3DQEB +# CwUAA4IBAQC3dGe0PkwlL2I1gZzSduWn4ih4dMPsGeUT+bYjlE9ip0zmTnLCJJDQ +# ebqozddE3wA5MPEoxHJveKyQCy2j6oWtFMILFJk/+yN0raiqzCJjMiUBK8rQFkZC +# WqdER1gdBEHi0TG+l2E7rgQYbHp6gV+rIv4I1jWOpw317CDc3G3HonbY+2aoQwMB +# Iaig9kzm1ILO1w0B1jOskKPgkrsYAnVDAnoEtNgV7VeRPBLnjWb4vRTMRoLW+gPA +# Cg18sYAP66EaNqV1HzzYOurnlYHerFr7nbXMEU4qdBHWf3lCYcohQWAepN3x2XSw +# 1aXoC0yBid/MhhYlGaUUV5WiiiJ7sWWNMIIFfDCCBGSgAwIBAgIIC+Y6yZLvZ7ow +# DQYJKoZIhvcNAQELBQAwgcYxCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6b25h +# MRMwEQYDVQQHEwpTY290dHNkYWxlMSUwIwYDVQQKExxTdGFyZmllbGQgVGVjaG5v +# bG9naWVzLCBJbmMuMTMwMQYDVQQLEypodHRwOi8vY2VydHMuc3RhcmZpZWxkdGVj +# aC5jb20vcmVwb3NpdG9yeS8xNDAyBgNVBAMTK1N0YXJmaWVsZCBTZWN1cmUgQ2Vy +# dGlmaWNhdGUgQXV0aG9yaXR5IC0gRzIwHhcNMjAwOTA5MDcwMDAwWhcNMjUwOTA5 +# MDcwMDAwWjCBhzELMAkGA1UEBhMCVVMxEDAOBgNVBAgTB0FyaXpvbmExEzARBgNV +# BAcTClNjb3R0c2RhbGUxJDAiBgNVBAoTG1N0YXJmaWVsZCBUZWNobm9sb2dpZXMs +# IExMQzErMCkGA1UEAxMiU3RhcmZpZWxkIFRpbWVzdGFtcCBBdXRob3JpdHkgLSBH +# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALon4MOqu6KEXlmadcf6 +# Vc9xVcvnjfIiyBbdp4TTuY8tXVhHKHFrI6IrB4ye3Eqek/1HyIwzkrid8nsJ1nzE +# WPuHUTtjAMEMm2C6XcF9mCEbMsbsEi5KBW+/rnGkdJUlhs4oGTBWm9sTeVzUjw/l +# nu/AcKNyP/+Xhdp3sSULQtFqOGSn+/g9v72rBdSSLUzYzDh6PXAaoVh+slhTTBU5 +# z1lTJmntomeQ3txRE9cAgFLcpyYT/OVHzJczL9Ya1UVfEgvdsdOzMsxUo26ejorX +# ecIgKRsa58ZN/Eg520oBGKcdhrv/vWkmrxlqvg8SLysbJEauUMvQWif0BTi7fG8e +# 2TsCAwEAAaOCAakwggGlMAwGA1UdEwEB/wQCMAAwDgYDVR0PAQH/BAQDAgbAMBYG +# A1UdJQEB/wQMMAoGCCsGAQUFBwMIMB0GA1UdDgQWBBT6DlZio+vLf7r6oeHTruUy +# owGsoTAfBgNVHSMEGDAWgBQlRYFoUCY4PTstLL7Natm2PbNmYzCBhAYIKwYBBQUH +# AQEEeDB2MCoGCCsGAQUFBzABhh5odHRwOi8vb2NzcC5zdGFyZmllbGR0ZWNoLmNv +# bS8wSAYIKwYBBQUHMAKGPGh0dHA6Ly9jcmwuc3RhcmZpZWxkdGVjaC5jb20vcmVw +# b3NpdG9yeS9zZl9pc3N1aW5nX2NhLWcyLmNydDBUBgNVHR8ETTBLMEmgR6BFhkNo +# dHRwOi8vY3JsLnN0YXJmaWVsZHRlY2guY29tL3JlcG9zaXRvcnkvbWFzdGVyc3Rh +# cmZpZWxkMmlzc3VpbmcuY3JsMFAGA1UdIARJMEcwRQYLYIZIAYb9bgEHFwIwNjA0 +# BggrBgEFBQcCARYoaHR0cDovL2NybC5zdGFyZmllbGR0ZWNoLmNvbS9yZXBvc2l0 +# b3J5LzANBgkqhkiG9w0BAQsFAAOCAQEAxhcu+G7OXRsN/Xhgk7BFeMskTcZUz8GD +# cW+aVs+bBLwUsb2ND2XA0y4tlAoH1ZHDvNgo71vr0wxZMs1clBhW8TQ1EiUAkgZf +# ucvvghxw3P/IQPEBvHcGVmB+CwjyuJZDsERIijQ1rhHot9WjXhEhtSVSZVRwCp7X +# c9jXgJWufPmIgA8Dyz/C5wC/ac4AZn5jP77m7GMc5RGs1bD3WUCk/14FExKEpPSA +# Qge06KZDl4u6KeEVIhaIEsRW9kheDWYvG7oN+ppBMiVlNS3hoXjGtYD8KCgskToB +# ttoEwlNSurfTkZW+gtfV3DcjsVyQaxXuu0wY4kUypYAqDje/5lBxCDGCBOUwggTh +# AgEBMIHKMIG0MQswCQYDVQQGEwJVUzEWMBQGA1UEChMNRW50cnVzdCwgSW5jLjEo +# MCYGA1UECxMfU2VlIHd3dy5lbnRydXN0Lm5ldC9sZWdhbC10ZXJtczE5MDcGA1UE +# CxMwKGMpIDIwMTUgRW50cnVzdCwgSW5jLiAtIGZvciBhdXRob3JpemVkIHVzZSBv +# bmx5MSgwJgYDVQQDEx9FbnRydXN0IENvZGUgU2lnbmluZyBDQSAtIE9WQ1MxAhEA +# tTPllraQMEYAAAAAVWavIzANBglghkgBZQMEAgEFAKB8MBAGCisGAQQBgjcCAQwx +# AjAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQBgjcCAQsxDjAM +# BgorBgEEAYI3AgEVMC8GCSqGSIb3DQEJBDEiBCB6Qom3p5O0WJO7qELbBzQSCzRx +# 6xfY6mlLis2bf4WOhzANBgkqhkiG9w0BAQEFAASCAQCxXP1fNrezf76gtrvc3Phi +# Bv5cR/nXmhZw8GAo3tU9fGJYUQw9Fiux086Pq2m47+DcWSKtXYYdFv83vCdcnNZ+ +# zzasLy4dRfPgJ2t4vpzQ7LE+mLFZu5oJMNS4j1YwUPh4qZ0GpNxMlfOgLZSGgPdm +# W8QDo3vEPOcYnK2LKNuq5XrRVWbLXU5cyk1GkyWU1LpcozhV23ju3YLIUEOXxuh+ +# 5icNenZSd/coYzBTEoIgf7gL3Oa6eiiyNxnPNPBDP+Z8jC8TJo8uD6y3jo04YkJv +# fG7WJt1gDSM8cWVthhUKjE7Jzd2f8aYBNfu9GbcpjcdSFCZCYN7FbsxcDH37O+Ea +# oYICbTCCAmkGCSqGSIb3DQEJBjGCAlowggJWAgEBMIHTMIHGMQswCQYDVQQGEwJV +# UzEQMA4GA1UECBMHQXJpem9uYTETMBEGA1UEBxMKU2NvdHRzZGFsZTElMCMGA1UE +# ChMcU3RhcmZpZWxkIFRlY2hub2xvZ2llcywgSW5jLjEzMDEGA1UECxMqaHR0cDov +# L2NlcnRzLnN0YXJmaWVsZHRlY2guY29tL3JlcG9zaXRvcnkvMTQwMgYDVQQDEytT +# dGFyZmllbGQgU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eSAtIEcyAggL5jrJ +# ku9nujAJBgUrDgMCGgUAoF0wGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkq +# hkiG9w0BCQUxDxcNMjEwNDE5MTIwMzMyWjAjBgkqhkiG9w0BCQQxFgQUpHGY2afI +# eDGbB4ErZZYlPFPIpeswDQYJKoZIhvcNAQEBBQAEggEAM5XBPNO+y1j+38bDQsMS +# 3HOEoI9N7NAWgGYHkVUCMzmYMq2r8lG5lbk4aB8onKfnLiITsnsA+OW3zGUsUJ+p +# +ZXBvG71yf3fYYinQUUKGQo9grH/zoU4LsCKmBLAP5QLhHZAb75TZJEMbHrJNq7A +# aLLNfqpEleSNZSxWAUM7gcPaKcxsL5IvgAlOAN4HMNrehvI0q3ZgrYUCuIhSumps +# qbxlGCEKCXyzFIU3skwxgcYc9h31nyUnP7RI5s7mtBFVMBIEQWenM5X5/2stlQ+S +# PNaGDopRLr7fE+POeSilB9dZIM8aedQNejxDi3U0ZkGki17HI7clHYU9zZRjEF15 +# gA== +# SIG # End signature block diff --git a/packages/SolidFire.SDK.dll b/packages/SolidFire.SDK.dll new file mode 100644 index 0000000..0958b73 Binary files /dev/null and b/packages/SolidFire.SDK.dll differ diff --git a/packages/SolidFire.dll b/packages/SolidFire.dll index f6bf136..c4c35c2 100644 Binary files a/packages/SolidFire.dll and b/packages/SolidFire.dll differ diff --git a/packages/SolidFire.dll-help.xml b/packages/SolidFire.dll-help.xml index 1059647..c46755a 100644 --- a/packages/SolidFire.dll-help.xml +++ b/packages/SolidFire.dll-help.xml @@ -1,21210 +1,45700 @@ - - - - - Add-SFDrive - - [Cluster] Adds available drives to the cluster. - - - - - Add - SFDrive - - - - [Cluster] Adds available drives to the cluster. - - - - DriveID - - The list of drive IDs to add to the cluster. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Adds available drives to the cluster. - - - - - - - - - - AddDrivesResult - solidfire.github.io/sdk-dotnet - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFDrive -DriveID 23 - - Adds a single available drive to the cluster by DriveID. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Add-SFDrive -DriveID 9,13 - - Adds two drives with IDs 9 and 13 to the cluster. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFDrive | Where-Object {$_.status -eq "available"} | Add-SFDrive - - Adds all available drives to the cluster. - - - - - - - Add-SFInitiatorToVolumeAccessGroup - - [Cluster] Adds initiators to an existing volume access group. - - - - - Add - SFInitiatorToVolumeAccessGroup - - - - [Cluster] Adds initiators to an existing volume access group. - - - - Initiators - - List of initiator names (IQNs and WWPNs) to include in the volume access group. - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID or list of volume access group IDs. - - long - - long - - - - - - - - - System.Int64 -System.String[] - - - - - [Cluster] Adds initiators to an existing volume access group. - - - - - - - - - - VolumeAccessGroup - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFInitiatorToVolumeAccessGroup -VolumeAccessGroupID 5 -Initiators "iqn.1994-05.com.redhat:8afd1bec9877","iqn.1998-01.com.vmware:pcl-1" - - Adds a pair of iSCSI initiators (IQNs) to a volume access group. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Add-SFInitiatorToVolumeAccessGroup -VolumeAccessGroupID 5 -Initiators "21:00:00:0e:1e:09:bb:8a" - - Adds a Fibre Channel initiator (WWPN) to a volume access group. - - - - - - - Add-SFNode - - [Cluster] Adds a SolidFire node to the cluster. - - - - - Add - SFNode - - - - [Cluster] Adds a SolidFire node to the cluster. - - - - PendingNodeID - - Enter one or more pending Node IDs. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Adds a SolidFire node to the cluster. - - - - - - - - - - PendingNode[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingNode.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFNode -PendingNodeID 5 - - Adds a single pending node to the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFPendingNode | Add-SFNode - - Adds all pending nodes. - - - - - - - Add-SFSnmpNetwork - - [Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes. - - - - - Add - SFSnmpNetwork - - - - [Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes. - - - - Access - - ro: read-only access.*, rw: for read-write access, rosys: for read-only access to a restricted set of system information. - - string - - string - - - - - - Cidr - - A Cidr network mask. This network mask must be an integer greater than or equal to 0, and less than or equal to 32. It must also not be equal to 31. - - int - - int - - - - - - Community - - SNMP community string. - - string - - string - - - - - - Confirm - - - - - switch - - - - - - Network - - This parameter, along with the cidr variable, is used to control which network the access and community string apply to. The special value of 'default' is used to specify an entry that applies to all networks. The cidr mask is ignored when network value is either a host name or default. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes. - - - - - - - - - - GetSnmpACLResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFSnmpNetwork -Access ro -Cidr 24 -Community readonly -Network 10.10.10.0 - - Adds a read-only network (10.10.10.0) to the community "readonly". - - - - - - - Add-SFSnmpTrapRecipient - - [Cluster] Adds a host that receives traps generated by the cluster master. - - - - - Add - SFSnmpTrapRecipient - - - - [Cluster] Adds a host that receives traps generated by the cluster master. - - - - Community - - SNMP community string.. - - string - - string - - - - - - Confirm - - - - - switch - - - - - - Host - - The IP address or host name of the target network management station. - - string - - string - - - - - - Port - - The UDP port number on the host where the trap is to be sent. Valid range is 1 �" 65535. 0 (zero) is not a valid port number. Most SNMP ports are at 162. - - int - - int - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Adds a host that receives traps generated by the cluster master. - - - - - - - - - - GetSnmpTrapInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFSnmpTrapRecipient -Host 10.10.10.10 -Community readonly -Port 162 - - Add a single trap recipient. - - - - - - - Add-SFSnmpUsmUser - - [Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster. - - - - - Add - SFSnmpUsmUser - - - - [Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster. - - - - Access - - rouser: read-only access.*, rwuser: for read-write access, rosys: for read-only access to a restricted set of system information. - - string - - string - - - - - - Confirm - - - - - switch - - - - - - Name - - The name of the user. Must contain at least one character but be no longer than 32 characters. No blank space. - - string - - string - - - - - - Passphrase - - The passphrase of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'priv'. - - string - - string - - - - - - Password - - The password of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'auth' or 'priv.' - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SecLevel - - 'noauth': no password or passphrase required. 'auth': a password is required for user access. 'priv': a password and passphrase is required for user access. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster. - - - - - - - - - - GetSnmpACLResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFSnmpUsmUser -Name snmpUser -Access rouser -Password snmpPass -Passphrase dummyPhrase -SecLevel noauth - - Creates a new SNMP USM user "snmpUser". Since the SecLevel is set to "noauth" the password and passphrase are entered only as dummy parameters. - - - - - - - Add-SFVolumeToVolumeAccessGroup - - [Cluster] Adds one or more volumes to an existing volume access group. - - - - - Add - SFVolumeToVolumeAccessGroup - - - - [Cluster] Adds one or more volumes to an existing volume access group. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID or list of volume access group IDs. - - long - - long - - - - - - VolumeID - - List of initiator names (IQNs and WWPNs) to include in the volume access group - - long[] - - long[] - - - - - - - - - System.Int64 -System.Int64[] - - - - - [Cluster] Adds one or more volumes to an existing volume access group. - - - - - - - - - - VolumeAccessGroup - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Add-SFVolumeToVolumeAccessGroup -VolumeAccessGroupID 5 -VolumeID 15 - - Adds volume ID 15 to volume access group ID 5. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroup -Name "Test" | Add-SFVolumeToVolumeAccessGroup -VolumeID 435 - - Adds volume ID 435 to the volume access group named "Test". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolume -Name "VMware*" | Add-SFVolumeToVolumeAccessGroup -VolumeAccessGroupID 5 - - Add all volumes with names beginning with "VMware" to volume access group ID 5. - - - - - - - Complete-SFClusterPairing - - [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. - - - - - Complete - SFClusterPairing - - - - [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. - - - - ClusterPairingKey - - A string of characters that is returned from the StartClusterPairing API method. - - string - - string - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String - - - - - [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. - - - - - - - - - - CompleteClusterPairingResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CompleteClusterPairingResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Start-SFClusterPairing | Complete-SFClusterPairing - - Completes the pairing process with the generated ClusterPairingKey. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - $key = Start-SFClusterPairing -Complete-SFClusterPairing -ClusterPairingKey $key.ClusterPairingKey - - Completes the pairing process with the generated ClusterPairingKey. Does the same as example 1 but also saves the data. - - - - - - - Complete-SFVolumePairing - - [Cluster] Completes the pairing of two volumes. - - - - - Complete - SFVolumePairing - - - - [Cluster] Completes the pairing of two volumes. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - The ID of the volume on which to complete the pairing process. - - long - - long - - - - - - VolumePairingKey - - A string of characters that is returned from the StartVolumePairing API method. - - string - - string - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String -System.Int64 - - - - - [Cluster] Completes the pairing of two volumes. - - - - - - - - - - CompleteVolumePairingResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CompleteVolumePairingResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Start-SFVolumePairing -VolumeID 2 -Mode Async | Complete-SFVolumePairing -VolumeID 3 - - Saved the pairing key for volume ID 2 from the Start command, while setting Mode to "Async", and uses it to complete pairing with volume id 3. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - $vol = Start-SFVolumePairing -VolumeID 8 -Mode Async -Complete-SFVolumePairing -VolumeID 9 -VolumePairingKey $vol.VolumePairingKey - - Saved the pairing key from the Start command, while setting Mode to "Async", and uses it to complete pairing with second volume. Does same thing as example 1 butalso saves the data. - - - - - - - Connect-SFCluster - - [Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection. - - - - - Connect - SFCluster - - - - [Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection. - - - - Credential - - Please supply a valid PSCredential. Use Get-Credential. - - pscredential - - pscredential - - - - - - Node - - Enter a valid SF node FQDN or IP address - - - switch - - - - - - Password - - Enter a valid password - - string - - string - - - - - - Port - - Enter the Port number - - int - - int - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - Enter a valid SolidFire cluster or node FQDN or IP address - - string - - string - - - - - - Timeout - - Use this parameter to change the timeout of the http client. Default is 40 seconds. - - int - - int - - - - - - Username - - Enter a valid user name - - string - - string - - - - - - VersionApi - - Enter the API Version number - - float - - float - - - - - - - - - System.Management.Automation.PSCredential - - - - - [Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection. - - - - - - - Successfully connected to '[Name]' with address '[Target]'. - - - SFConnection - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Connect-SFCluster 172.27.1.56 - - Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Connect-SFCluster 172.27.1.56 -Username clusterAdmin -Password clearPassword - - Note that using Connect-SFCluster in this manner requires a clear-text password be entered on the command line. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Connect-SFCluster 172.27.1.5 -Node - + + + + + Add-SFClusterInterfacePreference + + [Cluster] Lets you add a value to the key-value store. Works similar to a dictionary. + + + + + Add + SFClusterInterfacePreference + + + + Creates a new cluster preference and stores it on the storage cluster. The ClusterInterfacePreference related APIs can be used by internal interfaces to the storage cluster such as HCI and UI to store arbitrary information in the cluster. Since the API calls in the UI are visible to customers, these APIs are made public. + + + + Add-SFClusterInterfacePreference + + Name + + Name of the key. + + string + + + + Value + + Value stored in the key-value store. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Name + + Name of the key. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Value + + Value stored in the key-value store. + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + CreateClusterInterfacePreferenceResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateClusterInterfacePreferenceResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFClusterInterfacePreference -Name "bestPet" -Value "dog" + + Adds a new entry to the key-value store. + + + + + + + Add-SFDrive + + [Cluster] Adds available drives to the cluster. + + + + + Add + SFDrive + + + + [Cluster] Adds available drives to the cluster. + + + + Add-SFDrive + + DriveID + + The list of drive IDs to add to the cluster. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DriveID + + The list of drive IDs to add to the cluster. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + AddDrivesResult + solidfire.github.io/sdk-dotnet + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFDrive -DriveID 23 + + Adds a single available drive to the cluster by DriveID. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Add-SFDrive -DriveID 9,13 + + Adds two drives with IDs 9 and 13 to the cluster. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFDrive | Where-Object {$_.status -eq "available"} | Add-SFDrive + + Adds all available drives to the cluster. + + + + + + + Add-SFInitiatorToVolumeAccessGroup + + [Cluster] Adds initiators to an existing volume access group. + + + + + Add + SFInitiatorToVolumeAccessGroup + + + + [Cluster] Adds initiators to an existing volume access group. + + + + Add-SFInitiatorToVolumeAccessGroup + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs. + + long + + + + Initiators + + List of initiator names (IQNs and WWPNs) to include in the volume access group. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Initiators + + List of initiator names (IQNs and WWPNs) to include in the volume access group. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs. + + long + + long + + + + + + + + System.Int64 +System.String[] + + + + + + + + + + + + + VolumeAccessGroup + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFInitiatorToVolumeAccessGroup -VolumeAccessGroupID 5 -Initiators "iqn.1994-05.com.redhat:8afd1bec9877","iqn.1998-01.com.vmware:pcl-1" + + Adds a pair of iSCSI initiators (IQNs) to a volume access group. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Add-SFInitiatorToVolumeAccessGroup -VolumeAccessGroupID 5 -Initiators "21:00:00:0e:1e:09:bb:8a" + + Adds a Fibre Channel initiator (WWPN) to a volume access group. + + + + + + + Add-SFKeyServerToProviderKmip + + [Cluster] Creates a KMIP (Key Management Interoperability Protocol) Key Provider + + + + + Add + SFKeyServerToProviderKmip + + + + [Cluster] A Key Provider defines a mechanism and location to retrieve authentication keys. A KMIP Key Provider represents a collection of one or more KMIP Key Servers. A newly created KMIP Key Provider will not have any KMIP Key Servers assigned to it. To create a KMIP Key Server see CreateKeyServerKmip and to assign it to a provider created via this method see AddKeyServerToProviderKmip. + + + + Add-SFKeyServerToProviderKmip + + KeyProviderID + + The ID of the Key Provider to assign the KMIP Key Server to. + + long + + + + KeyServerID + + The ID of the KMIP Key Server to assign. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyProviderID + + The ID of the Key Provider to assign the KMIP Key Server to. + + long + + long + + + + + KeyServerID + + The ID of the KMIP Key Server to assign. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + AddKeyServerToProviderKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFKeyServerToProviderKmip -KeyServerID 5 -KeyProviderID 1 + + Adds a key server to a key provider. + + + + + + + Add-SFNode + + [Cluster] Adds a SolidFire node to the cluster. + + + + + Add + SFNode + + + + [Cluster] Adds a SolidFire node to the cluster. + + + + Add-SFNode + + PendingNodeID + + Enter one or more pending Node IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + PendingNodeID + + Enter one or more pending Node IDs. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + PendingNode[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingNode.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFNode -PendingNodeID 5 + + Adds a single pending node to the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFPendingNode | Add-SFNode + + Adds all pending nodes. + + + + + + + Add-SFSnmpNetwork + + [Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes. + + + + + Add + SFSnmpNetwork + + + + [Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes. + + + + Add-SFSnmpNetwork + + Access + + ro: read-only access.*, rw: for read-write access, rosys: for read-only access to a restricted set of system information. + + string + + + + Cidr + + A Cidr network mask. This network mask must be an integer greater than or equal to 0, and less than or equal to 32. It must also not be equal to 31. + + int + + + + Community + + SNMP community string. + + string + + + + Network + + This parameter, along with the cidr variable, is used to control which network the access and community string apply to. The special value of 'default' is used to specify an entry that applies to all networks. The cidr mask is ignored when network value is either a host name or default. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Access + + ro: read-only access.*, rw: for read-write access, rosys: for read-only access to a restricted set of system information. + + string + + string + + + + + Cidr + + A Cidr network mask. This network mask must be an integer greater than or equal to 0, and less than or equal to 32. It must also not be equal to 31. + + int + + int + + + + + Community + + SNMP community string. + + string + + string + + + + + Confirm + + + + + switch + + + + + Network + + This parameter, along with the cidr variable, is used to control which network the access and community string apply to. The special value of 'default' is used to specify an entry that applies to all networks. The cidr mask is ignored when network value is either a host name or default. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + GetSnmpACLResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFSnmpNetwork -Access ro -Cidr 24 -Community readonly -Network 10.10.10.0 + + Adds a read-only network (10.10.10.0) to the community "readonly". + + + + + + + Add-SFSnmpTrapRecipient + + [Cluster] Adds a host that receives traps generated by the cluster master. + + + + + Add + SFSnmpTrapRecipient + + + + [Cluster] Adds a host that receives traps generated by the cluster master. + + + + Add-SFSnmpTrapRecipient + + Host + + The IP address or host name of the target network management station. + + string + + + + Community + + SNMP community string.. + + string + + + + Port + + The UDP port number on the host where the trap is to be sent. Valid range is 1 - 65535. 0 (zero) is not a valid port number. Most SNMP ports are at 162. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Community + + SNMP community string.. + + string + + string + + + + + Confirm + + + + + switch + + + + + Host + + The IP address or host name of the target network management station. + + string + + string + + + + + Port + + The UDP port number on the host where the trap is to be sent. Valid range is 1 - 65535. 0 (zero) is not a valid port number. Most SNMP ports are at 162. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + GetSnmpTrapInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFSnmpTrapRecipient -Host 10.10.10.10 -Community readonly -Port 162 + + Add a single trap recipient. + + + + + + + Add-SFSnmpUsmUser + + [Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster. + + + + + Add + SFSnmpUsmUser + + + + [Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster. + + + + Add-SFSnmpUsmUser + + Access + + rouser: read-only access.*, rwuser: for read-write access, rosys: for read-only access to a restricted set of system information. + + string + + + + Name + + The name of the user. Must contain at least one character but be no longer than 32 characters. No blank space. + + string + + + + Password + + The password of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'auth' or 'priv.' + + string + + + + Passphrase + + The passphrase of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'priv'. + + string + + + + SecLevel + + 'noauth': no password or passphrase required. 'auth': a password is required for user access. 'priv': a password and passphrase is required for user access. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Access + + rouser: read-only access.*, rwuser: for read-write access, rosys: for read-only access to a restricted set of system information. + + string + + string + + + + + Confirm + + + + + switch + + + + + Name + + The name of the user. Must contain at least one character but be no longer than 32 characters. No blank space. + + string + + string + + + + + Passphrase + + The passphrase of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'priv'. + + string + + string + + + + + Password + + The password of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'auth' or 'priv.' + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SecLevel + + 'noauth': no password or passphrase required. 'auth': a password is required for user access. 'priv': a password and passphrase is required for user access. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + GetSnmpACLResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFSnmpUsmUser -Name snmpUser -Access rouser -Password snmpPass -Passphrase dummyPhrase -SecLevel noauth + + Creates a new SNMP USM user "snmpUser". Since the SecLevel is set to "noauth" the password and passphrase are entered only as dummy parameters. + + + + + + + Add-SFVolumeToVolumeAccessGroup + + [Cluster] Adds one or more volumes to an existing volume access group. + + + + + Add + SFVolumeToVolumeAccessGroup + + + + [Cluster] Adds one or more volumes to an existing volume access group. + + + + Add-SFVolumeToVolumeAccessGroup + + VolumeAccessGroupID + + ID of volume access group to modify. + + long + + + + VolumeID + + List of volume IDs to add to the volume access group. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + ID of volume access group to modify. + + long + + long + + + + + VolumeID + + List of volume IDs to add to the volume access group. + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + VolumeAccessGroup + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Add-SFVolumeToVolumeAccessGroup -VolumeAccessGroupID 5 -VolumeID 15 + + Adds volume ID 15 to volume access group ID 5. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VMware*" | Add-SFVolumeToVolumeAccessGroup -VolumeAccessGroupID 5 + + Adds all volumes with names beginning with "VMware" to volume access group ID 5. + + + + + + + Complete-SFClusterPairing + + [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. + + + + + Complete + SFClusterPairing + + + + [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. + + + + Complete-SFClusterPairing + + ClusterPairingKey + + A string of characters that is returned from the StartClusterPairing API method. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + ClusterPairingKey + + A string of characters that is returned from the StartClusterPairing API method. + + string + + string + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String + + + + + + + + + + + + + CompleteClusterPairingResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CompleteClusterPairingResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Start-SFClusterPairing -Target 10.192.6.133 | Complete-SFClusterPairing -Target 10.192.6.135 + + Completes the pairing process with the generated ClusterPairingKey. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + $key = Start-SFClusterPairing -Target 10.192.6.133 +Complete-SFClusterPairing -ClusterPairingKey $key.ClusterPairingKey -Target 10.192.6.135 + + Completes the pairing process with the generated ClusterPairingKey. Does the same as example 1 but also saves the data. + + + + + + + Complete-SFVolumePairing + + [Cluster] Completes the pairing of two volumes. + + + + + Complete + SFVolumePairing + + + + [Cluster] Completes the pairing of two volumes. + + + + Complete-SFVolumePairing + + VolumePairingKey + + A string of characters that is returned from the StartVolumePairing API method. + + string + + + + VolumeID + + The ID of the volume on which to complete the pairing process. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + The ID of the volume on which to complete the pairing process. + + long + + long + + + + + VolumePairingKey + + A string of characters that is returned from the StartVolumePairing API method. + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.String +System.Int64 + + + + + + + + + + + + + CompleteVolumePairingResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CompleteVolumePairingResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Complete-SFVolumePairing -VolumeID 18 -VolumePairingKey $vol_pairing_key + + Completes a volume pairing using a pairing key previously obtained from the Start-SFVolumePairing cmdlet. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Start-SFVolumePairing -VolumeID 42 -Mode Async -Target Cluster1 | Complete-SFVolumePairing -VolumeID 18 -Target Cluster2 + + Creates a volume pairing key and pipes it to the Complete-SFVolumePairing cmdlet to create a volume pair. + + + + + + + Connect-SFCluster + + [Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection. + + + + + Connect + SFCluster + + + + [Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection. + + + + Connect-SFCluster + + Target + + Direct connection to specific Target + + string + + + + Credential + + Please supply a valid PSCredential. Use Get-Credential. + + pscredential + + + + Node + + Enter a valid SF node FQDN or IP address + + + + + VersionApi + + Enter the API Version number + + float + + + + Port + + Enter the Port number + + int + + + + Timeout + + Use this parameter to change the timeout of the http client. Default is 40 seconds. + + int + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Connect-SFCluster + + Target + + Direct connection to specific Target + + string + + + + Username + + Enter a valid user name + + string + + + + Password + + Enter a valid password + + string + + + + Node + + Enter a valid SF node FQDN or IP address + + + + + VersionApi + + Enter the API Version number + + float + + + + Port + + Enter the Port number + + int + + + + Timeout + + Use this parameter to change the timeout of the http client. Default is 40 seconds. + + int + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Credential + + Please supply a valid PSCredential. Use Get-Credential. + + pscredential + + pscredential + + + + + Node + + Enter a valid SF node FQDN or IP address + + + switch + + + + + Password + + Enter a valid password + + string + + string + + + + + Port + + Enter the Port number + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string + + string + + + + + Timeout + + Use this parameter to change the timeout of the http client. Default is 40 seconds. + + int + + int + + + + + Username + + Enter a valid user name + + string + + string + + + + + VersionApi + + Enter the API Version number + + float + + float + + + + + + + + System.Management.Automation.PSCredential + + + + + + + + + + Successfully connected to '[Name]' with address '[Target]'. + + + SFConnection + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Connect-SFCluster 172.27.1.56 + + Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Connect-SFCluster 172.27.1.56 -Username clusterAdmin -Password clearPassword + + Note that using Connect-SFCluster in this manner requires a clear-text password be entered on the command line. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Connect-SFCluster 172.27.1.5 -Node + This will create a connection to a specific node. If a node is already in a cluster, then it will use the same cluster admin credentials as the cluster. If the node has not yet been added to a cluster, then any username and password can be used. -Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - +Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + $cred = Get-Credential -$cred | Connect-SFCluster 172.27.1.56 - +$cred | Connect-SFCluster 172.27.1.56 + The example first prompts for cluster credentials and stores them as a PSCredential object. The credentials can then be piped directly into Connect-SFCluster. -Note: Credentials stored in this manner can be saved to a file with the Export-CliXml cmdlet and retrieved with the Import-CliXml cmdlet. - - - - -------------------------- EXAMPLE 5 -------------------------- - - PS C:\> - - Connect-SFCluster 172.27.1.56 -VersionApi 7.0 - - Connects to a cluster using a specific API end point. For example, you could connect to a cluster running 8.2 on the 7.0 end point. - - - - - - - Copy-SFVolume - - Copies one volume to another. - - - - - Copy - SFVolume - - - - Copies one volume to another. - - - - DstVolumeID - - Destination volume for the copy. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - Snapshot ID of the source volume to create the copy from. - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Source volume to copy. - - long - - long - - - - - - - - - System.Int64 - - - - - Copies one volume to another. - - - - - - - Copies one volume to another. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Copy-SFVolume -VolumeID 267 -DstVolumeID 269 - - This will copy contents of VolumeID 267 to existing VolumeID 269. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Copy-SFVolume -VolumeID 267 -DstVolumeID 270 -SnapshotID 2610 - - This copies the contents of existing SnapshotID 2610 of VolumeID 267 to existing VolumeID 270. - - - - - - - Disable-SFEncryptionAtRest - - [Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet. - - - - - Disable - SFEncryptionAtRest - - - - [Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet. - - - - - - - - - - DisableEncryptionAtRestResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DisableEncryptionAtRestResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Disable-SFEncryptionAtRest -Confirm:$false - - Disables SFEncryptionAtRest with no confirmation prompt - - - - - - - Disable-SFSnmp - - [Cluster] Disables SNMP on the SolidFire cluster. - - - - - Disable - SFSnmp - - - - [Cluster] Disables SNMP on the SolidFire cluster. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Disables SNMP on the SolidFire cluster. - - - - - - - - - - GetSnmpStateResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Disable-SFSnmp - - Disables SNMP on the connected cluster. - - - - - - - Disconnect-SFCluster - - [Node/Cluster] Disconnects a cluster or node connection. - - - - - Disconnect - SFCluster - - - - [Node/Cluster] Disconnects a cluster or node connection. - - - - Name - - Name of a node or cluster to disconnect from - - string[] - - string[] - - - - - - Target - - Target address of node or cluster to disconnect from - - string[] - - string[] - - - - - - - - - System.String[] - - - - - [Node/Cluster] Disconnects a cluster or node connection. - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Disconnect-SFCluster - - Running Disconnect-SFCluster without any arguments will disconnect all SolidFire connections in $SFConnections. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Disconnect-SFCluster -Target 172.27.1.56 - - In this case Disconnect-SFCluster will only disconnect from the specified target IP or FQDN. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Disconnect-SFCluster -Name ClusterName - - In this case Disconnect-SFCluster will only disconnect from the specified cluster or node name. Wildcards can be used to disconnect from multiple clusters/nodes with similar names. For example: Cluster* will disconnect from any connections whos name begins with Cluster. - - - - - - - Enable-SFEncryptionAtRest - - [Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node. - - - - - Enable - SFEncryptionAtRest - - - - [Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node. - - - - - - - - - - EnableEncryptionAtRestResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EnableEncryptionAtRestResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Enable-SFEncryptionAtRest -Confirm:$false - - Enables SF Encryption at Rest with no confirmation prompt - - - - - - - Enable-SFFeature - - Enables cluster features that are disabled by default. - - - - - Enable - SFFeature - - - - Enables cluster features that are disabled by default. - - - - Feature - - Valid values: vvols: Enable the Virtual Volumes (VVOLs) cluster feature. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Enables cluster features that are disabled by default. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Enable-SFFeature - - Enable the Virtual Volumes (VVols) cluster feature. By default the command automatically choses to enable this without needing the "-Feature" flag. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Enable-SFFeature -Feature vvols - - Enable the Virtual Volumes (VVols) cluster feature. By default the "-Feature vvols" is not needed to run the command to enable "VVols". - - - - - - - Enable-SFSnmp - - [Cluster] Enables SNMP on the SolidFire cluster. - - - - - Enable - SFSnmp - - - - [Cluster] Enables SNMP on the SolidFire cluster. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnmpV3Enabled - - If set to 'true', then SNMP v3 is enabled on each node in the cluster. If set to 'false', then SNMP v2 is enabled. - - bool - - bool - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Boolean - - - - - [Cluster] Enables SNMP on the SolidFire cluster. - - - - - - - - - - GetSnmpStateResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Enable-SFSnmp -SnmpV3Enabled:$true - - Enable SNMP and SNMPv3. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Enable-SFSnmp -SnmpV3Enabled:$false - - Enable SNMP but disable SNMP v3 functionality. - - - - - - - Get-SFAccount - - [Cluster] Gets information on all active volume accounts on a SolidFire cluster. - - - - - Get - SFAccount - - - - [Cluster] Gets information on all active volume accounts on a SolidFire cluster. - - - - AccountID - - Enter an account ID or list of account IDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Username - - Enter a username or list of usernames - - string[] - - string[] - - - - - - - - - System.Int64[] -System.String[] - - - - - [Cluster] Gets information on all active volume accounts on a SolidFire cluster. - - - - - - - - - - Account[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFAccount - - Gets all active accounts in list format. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFAccount -Username sfadmin - - Gets SolidFire account object for the sfadmin account. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFAccount -Username <User1>,<User2> - - Gets information for both UserNames. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - - Get-SFAccount J* - - Gets all accounts with a Username beginning with the letter 'J'. - - - - -------------------------- EXAMPLE 5 -------------------------- - - PS C:\> - - Get-SFAccount 5 - - Gets account information for account with accountID 5. - - - - -------------------------- EXAMPLE 6 -------------------------- - - PS C:\> - - Get-SFAccount 5,6,8 - - Gets account information for accounts with accountID 5, 6, and 8. - - - - - - - Get-SFAccountEfficiency - - [Cluster] Gets storage efficiency information for a given account. - - - - - Get - SFAccountEfficiency - - - - [Cluster] Gets storage efficiency information for a given account. - - - - AccountID - - Enter an account ID - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets storage efficiency information for a given account. - - - - - - - - - - GetEfficiencyResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetEfficiencyResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFAccountEfficiency -AccountID 1 - - Gets storage efficiency information for the volumes owned by AccountID 1. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Note: Credentials stored in this manner can be saved to a file with the Export-CliXml cmdlet and retrieved with the Import-CliXml cmdlet. + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Connect-SFCluster 172.27.1.56 -VersionApi 7.0 + + Connects to a cluster using a specific API end point. For example, you could connect to a cluster running 8.2 on the 7.0 end point. + + + + -------------------------- EXAMPLE 6 -------------------------- + + PS C:\> + + Connect-SFCluster -Node 172.27.1.5 + + This will create a connection to a specific node. If a node is already in a cluster, then it will use the same cluster admin credentials as the cluster. If the node has not yet been added to a cluster, then any username and password can be used. + +Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password. + + + + + + + Copy-SFVolume + + Copies one volume to another. + + + + + Copy + SFVolume + + + + Copies one volume to another. + + + + Copy-SFVolume + + VolumeID + + Source volume to copy. + + long + + + + DstVolumeID + + Destination volume for the copy. + + long + + + + SnapshotID + + Snapshot ID of the source volume to create the copy from. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DstVolumeID + + Destination volume for the copy. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + Snapshot ID of the source volume to create the copy from. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Source volume to copy. + + long + + long + + + + + + + + System.Int64 + + + + + + + + + + Copies one volume to another. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Copy-SFVolume -VolumeID 267 -DstVolumeID 269 + + This will copy contents of VolumeID 267 to existing VolumeID 269. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Copy-SFVolume -VolumeID 267 -DstVolumeID 270 -SnapshotID 2610 + + This copies the contents of existing SnapshotID 2610 of VolumeID 267 to existing VolumeID 270. + + + + + + + Disable-SFClusterSsh + + [Cluster] Disables SSH on all nodes in the cluster. + + + + + Disable + SFClusterSsh + + + + [Cluster] Disables SSH on all nodes in the cluster. + + + + Disable-SFClusterSsh + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DisableClusterSshResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DisableClusterSshResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disable-SFClusterSsh + + Disables SSH clusterwide. + + + + + + + Disable-SFEncryptionAtRest + + [Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet. + + + + + Disable + SFEncryptionAtRest + + + + [Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet. + + + + Disable-SFEncryptionAtRest + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DisableEncryptionAtRestResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DisableEncryptionAtRestResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disable-SFEncryptionAtRest -Confirm:$false + + Disables SFEncryptionAtRest with no confirmation prompt + + + + + + + Disable-SFIdpAuthentication + + [Cluster] Disable support for authentication using third party Identity Providers (IdP) for the cluster. + + + + + Disable + SFIdpAuthentication + + + + [Cluster] Disable support for authentication using third party Identity Providers (IdP) for the cluster. + + + + Disable-SFIdpAuthentication + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetIdpAuthenticationStateResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disable-SFIdpAuthentication + + Disable IDP Authentication for the cluster + + + + + + + Disable-SFMaintenanceMode + + [Cluster] Take a node out of maintenance mode. This should be called after maintenance is complete and the node is online. + + + + + Disable + SFMaintenanceMode + + + + [Cluster] Take a node out of maintenance mode. This should be called after maintenance is complete and the node is online. + + + + Disable-SFMaintenanceMode + + Nodes + + List of NodeIDs to take out of maintenance mode. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Nodes + + List of NodeIDs to take out of maintenance mode. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + MaintenanceModeResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disable-SFMaintenanceMode -Nodes 1 + + Disables Maintenance Mode on Node with ID 1 + + + + + + + Disable-SFSnmp + + [Cluster] Disables SNMP on the SolidFire cluster. + + + + + Disable + SFSnmp + + + + [Cluster] Disables SNMP on the SolidFire cluster. + + + + Disable-SFSnmp + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + GetSnmpStateResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disable-SFSnmp + + Disables SNMP on the connected cluster. + + + + + + + Disable-SFSsh + + [Node] Disables SSH on the targeted node. + + + + + Disable + SFSsh + + + + [Node] Disables SSH on the targeted node. This does not effect the cluster-wide SSH timeout duration. The node is not exempt from the SSH shut off by the global timeout. + + + + Disable-SFSsh + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DisableSshResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DisableSshResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disable-SFSsh + + Disables SSH on the currently connected node. + + + + + + + Disconnect-SFCluster + + [Node/Cluster] Disconnects a cluster or node connection. + + + + + Disconnect + SFCluster + + + + [Node/Cluster] Disconnects a cluster or node connection. + + + + Disconnect-SFCluster + + Target + + Direct connection to specific Target + + string[] + + + + + Disconnect-SFCluster + + Name + + Name of a node or cluster to disconnect from + + string[] + + + + + + + Name + + Name of a node or cluster to disconnect from + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.String[] + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Disconnect-SFCluster + + Running Disconnect-SFCluster without any arguments will disconnect all SolidFire connections in $SFConnections. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Disconnect-SFCluster -Target 172.27.1.56 + + In this case Disconnect-SFCluster will only disconnect from the specified target IP or FQDN. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Disconnect-SFCluster -Name ClusterName + + In this case Disconnect-SFCluster will only disconnect from the specified cluster or node name. Wildcards can be used to disconnect from multiple clusters/nodes with similar names. For example: Cluster* will disconnect from any connections whos name begins with Cluster. + + + + + + + Enable-SFClusterSsh + + [Cluster] Enables SSH on all nodes in the cluster. + + + + + Enable + SFClusterSsh + + + + [Cluster] Enables SSH on all nodes in the cluster. Overwrites previous duration. + + + + Enable-SFClusterSsh + + Duration + + The duration on how long SSH will be enabled on the cluster. Follows format "HH:MM:SS.MS". + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Duration + + The duration on how long SSH will be enabled on the cluster. Follows format "HH:MM:SS.MS". + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + EnableClusterSshResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EnableClusterSshResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFClusterSsh -Duration "24:00:00" + + Enables SSH clusterwide for 24 hours. + + + + + + + Enable-SFEncryptionAtRest + + [Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node. + + + + + Enable + SFEncryptionAtRest + + + + [Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node. + + + + Enable-SFEncryptionAtRest + + KeyProviderID + + If a keyProviderID is specified then the password will be generated/retrieved as appropriate per the type of provider. Commonly this would be via a KMIP (Key Management Interoperability Protocol) Key Server in the case of a KMIP Key Provider (see New-SFKeyProviderKmip.) + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + KeyProviderID + + If a keyProviderID is specified then the password will be generated/retrieved as appropriate per the type of provider. Commonly this would be via a KMIP (Key Management Interoperability Protocol) Key Server in the case of a KMIP Key Provider (see New-SFKeyProviderKmip.) + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + EnableEncryptionAtRestResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EnableEncryptionAtRestResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFEncryptionAtRest -Confirm:$false + + Enables SF Encryption at Rest with no confirmation prompt + + + + + + + Enable-SFFeature + + Enables cluster features that are disabled by default. + + + + + Enable + SFFeature + + + + Enables cluster features that are disabled by default. + + + + Enable-SFFeature + + Feature + + Valid values: vvols: Enable the Virtual Volumes (VVOLs) cluster feature. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Feature + + Valid values: vvols: Enable the Virtual Volumes (VVOLs) cluster feature. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFFeature + + Enable the Virtual Volumes (VVols) cluster feature. By default the command automatically choses to enable this without needing the "-Feature" flag. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Enable-SFFeature -Feature vvols + + Enable the Virtual Volumes (VVols) cluster feature. By default the "-Feature vvols" is not needed to run the command to enable "VVols". + + + + + + + Enable-SFIdpAuthentication + + [Cluster] Enable support for authentication using a third party Identity Provider (IdP) for the cluster. + + + + + Enable + SFIdpAuthentication + + + + [Cluster] Enable support for authentication using a third party Identity Provider (IdP) for the cluster. + + + + Enable-SFIdpAuthentication + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + guid + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Guid + + + + + + + + + + + + + GetIdpAuthenticationStateResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFIdpAuthentication + + Enable IDP Authentication for the cluster if there is only IDP Configuration on the cluster + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Enable-SFIdpAuthentication -IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a + + Enable IDP Authentication for the cluster with IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a + + + + + + + Enable-SFMaintenanceMode + + [Cluster] Prepare a node for maintenance. Maintenance includes anything that will require the node to be powered-off or restarted. + + + + + Enable + SFMaintenanceMode + + + + [Cluster] Prepare a node for maintenance. Maintenance includes anything that will require the node to be powered-off or restarted. + + + + Enable-SFMaintenanceMode + + Nodes + + List of NodeIDs to put in maintenance mode. + + long[] + + + + PerMinutePrimarySwapLimit + + Number of primaries to swap per minute. If not specified, all will be swapped at once. + + long + + + + Timeout + + How long to allow maintenance mode to remain enabled before automatically disabling. Formatted in HH:mm:ss. If not specified, it will remain enabled until explicitly disabled. + + string + + + + ForceWithUnResolvedFaults + + Force maintenance mode to be enabled even with blocking cluster faults present. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ForceWithUnResolvedFaults + + Force maintenance mode to be enabled even with blocking cluster faults present. + + + switch + + + + + Nodes + + List of NodeIDs to put in maintenance mode. + + long[] + + long[] + + + + + PerMinutePrimarySwapLimit + + Number of primaries to swap per minute. If not specified, all will be swapped at once. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Timeout + + How long to allow maintenance mode to remain enabled before automatically disabling. Formatted in HH:mm:ss. If not specified, it will remain enabled until explicitly disabled. + + string + + string + + + + + + + + System.Int64[] +System.Int64 + + + + + + + + + + + + + MaintenanceModeResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFMaintenanceMode -Nodes 1 -PerMinutePrimarySwapLimit 1 -Timeout 00:30:00 -ForceWithUnResolvedFaults + + Enables Maintenance Mode for 30 minutes on Node with ID 1 with 1 swap per minute forcely + + + + + + + Enable-SFSnmp + + [Cluster] Enables SNMP on the SolidFire cluster. + + + + + Enable + SFSnmp + + + + [Cluster] Enables SNMP on the SolidFire cluster. + + + + Enable-SFSnmp + + SnmpV3Enabled + + If set to 'true', then SNMP v3 is enabled on each node in the cluster. If set to 'false', then SNMP v2 is enabled. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnmpV3Enabled + + If set to 'true', then SNMP v3 is enabled on each node in the cluster. If set to 'false', then SNMP v2 is enabled. + + bool + + bool + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Boolean + + + + + + + + + + + + + GetSnmpStateResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFSnmp -SnmpV3Enabled:$true + + Enable SNMP and SNMPv3. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Enable-SFSnmp -SnmpV3Enabled:$false + + Enable SNMP but disable SNMP v3 functionality. + + + + + + + Enable-SFSsh + + [Node] Enables SSH on the targeted node. + + + + + Enable + SFSsh + + + + [Node] Enables SSH on the targeted node. This does not effect the cluster-wide SSH timeout duration. The node is not exempt from the SSH shut off by the global timeout. + + + + Enable-SFSsh + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + EnableSshResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EnableSshResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Enable-SFSsh + + Enables SSH on the currently connected node. + + + + + + + Get-SFAccount + + [Cluster] Gets information on all active volume accounts on a SolidFire cluster. + + + + + Get + SFAccount + + + + [Cluster] Gets information on all active volume accounts on a SolidFire cluster. + + + + Get-SFAccount + + AccountID + + Enter an account ID or list of account IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFAccount + + Username + + Enter a username or list of usernames + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AccountID + + Enter an account ID or list of account IDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + Enter a username or list of usernames + + string[] + + string[] + + + + + + + + System.Int64[] +System.String[] + + + + + + + + + + + + + Account[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFAccount + + Gets all active accounts in list format. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFAccount -Username sfadmin + + Gets SolidFire account object for the sfadmin account. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFAccount -Username <User1>,<User2> + + Gets information for both UserNames. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFAccount J* + + Gets all accounts with a Username beginning with the letter 'J'. + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Get-SFAccount 5 + + Gets account information for account with accountID 5. + + + + -------------------------- EXAMPLE 6 -------------------------- + + PS C:\> + + Get-SFAccount 5,6,8 + + Gets account information for accounts with accountID 5, 6, and 8. + + + + + + + Get-SFAccountEfficiency + + [Cluster] Gets storage efficiency information for a given account. + + + + + Get + SFAccountEfficiency + + + + [Cluster] Gets storage efficiency information for a given account. + + + + Get-SFAccountEfficiency + + AccountID + + Enter an account ID + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AccountID + + Enter an account ID + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + GetEfficiencyResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetEfficiencyResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFAccountEfficiency -AccountID 1 + + Gets storage efficiency information for the volumes owned by AccountID 1. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $account = Get-SFAccount J* - PS C:\> Get-SFAccountEfficiency $account - - Gets storage efficiency information for the accounts in the $account variable. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - + PS C:\> Get-SFAccountEfficiency $account + + Gets storage efficiency information for the accounts in the $account variable. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + $account = Get-SFAccount J* - PS C:\> $account | Get-SFAccountEfficiency - - Gets storage efficiency information for the accounts in the $account variable. - - - - - - - Get-SFActiveNode - - [Cluster] Gets information about the active SolidFire nodes in the cluster. - - - - - Get - SFActiveNode - - - - [Cluster] Gets information about the active SolidFire nodes in the cluster. - - - - Name - - Enter a node name or list of node names - - string[] - - string[] - - - - - - NodeID - - Enter a node ID or list of node IDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] -System.String[] - - - - - [Cluster] Gets information about the active SolidFire nodes in the cluster. - - - - - - - - - - Node[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Node.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFActiveNode - - - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFActiveNode -Name "FCN*" - - Retrieve all nodes with names beginning with "FCN". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFActiveNode -NodeID 5,8 - - Gets active nodes ID 5 and 8. - - - - - - - Get-SFASyncResult - - [Cluster] Gets the result of an asynchronous method call. - - - - - Get - SFASyncResult - - - - [Cluster] Gets the result of an asynchronous method call. - - - - ASyncResultID - - Async Handle from a previous method call - - long - - long - - - - - - KeepResult - - If true, GetAsyncResult does not remove the asynchronous result upon returning it, enabling future queries to that asyncHandle. Default is false. - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64 - - - - - [Cluster] Gets the result of an asynchronous method call. - - - - - - - - - - GetAsyncResultRequest - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetAsyncResultRequest.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFASyncResult -ASyncResultID 34 - + PS C:\> $account | Get-SFAccountEfficiency + + Gets storage efficiency information for the accounts in the $account variable. + + + + + + + Get-SFActiveAuthSessions + + [Cluster] Gets a list of all active auth sessions on the cluster. + + + + + Get + SFActiveAuthSessions + + + + [Cluster] Gets a list of all active auth sessions on the cluster. + + + + Get-SFActiveAuthSessions + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + AuthSesssionInfo[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFActiveAuthSessions + + Gets the list of all active auth sessions. + + + + + + + Get-SFActiveNode + + [Cluster] Gets information about the active SolidFire nodes in the cluster. + + + + + Get + SFActiveNode + + + + [Cluster] Gets information about the active SolidFire nodes in the cluster. + + + + Get-SFActiveNode + + NodeID + + Enter a node ID or list of node IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFActiveNode + + Name + + Enter a node name or list of node names + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Name + + Enter a node name or list of node names + + string[] + + string[] + + + + + NodeID + + Enter a node ID or list of node IDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] +System.String[] + + + + + + + + + + + + + Node[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Node.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFActiveNode + + + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFActiveNode -Name "FCN*" + + Retrieve all nodes with names beginning with "FCN". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFActiveNode -NodeID 5,8 + + Gets active nodes ID 5 and 8. + + + + + + + Get-SFActiveTlsCiphers + + [Cluster] Get-SFActiveTlsCiphers gets a list of the TLS ciphers that are currently accepted on the cluster. + + + + + Get + SFActiveTlsCiphers + + + + [Cluster] Get-SFActiveTlsCiphers gets a list of the TLS ciphers that are currently accepted on the cluster. + + + + Get-SFActiveTlsCiphers + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetActiveTlsCiphersResult + + + + + + + + + Get-SFActiveVolume + + [Cluster] Gets a list of active volumes currently in the cluster. + + + + + Get + SFActiveVolume + + + + [Cluster] Gets a list of active volumes currently in the cluster. + + + + Get-SFActiveVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + Limit + + Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited). + + long + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFActiveVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + VolumeID + + Enter a VolumeID or list of VolumeIDs. + + long[] + + + + Limit + + Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited). + + long + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFActiveVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + Name + + Enter a volume name or list of volume names. + + string[] + + + + Limit + + Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited). + + long + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFActiveVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + AccountID + + Enter an Account ID or list of Account IDs. + + long[] + + + + Limit + + Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited). + + long + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFActiveVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + Account + + Specify account(s). + + Account[] + + + + Limit + + Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited). + + long + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Account + + Specify account(s). + + Account[] + + Account[] + + + + + AccountID + + Enter an Account ID or list of Account IDs. + + long[] + + long[] + + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + switch + + + + + Limit + + Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited). + + long + + long + + + + + Name + + Enter a volume name or list of volume names. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a VolumeID or list of VolumeIDs. + + long[] + + long[] + + + + + + + + System.Int64[] +System.String[] +SolidFire.Element.Api.Account[] + + + + + + + + + + + + + Volume + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFActiveVolume + + Gets all active volumes on the system. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VM*" + + Gets all active volumes with names that begin with "VM". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolume -VolumeID 3 + + Return only the active volume with ID 3. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFVolume -AccountID 13 + + Gets all active volumes associated with account ID 13. + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Get-SFAccount -Username "Customer*" | Get-SFVolume + + Gets all active volumes associated with all accounts that have names beginning with "Customer". + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Get-SFActiveVolume -Limit 5 + + Gets 5 active volumes. + + + + + + + Get-SFASyncResult + + [Cluster] Gets the result of an asynchronous method call. + + + + + Get + SFASyncResult + + + + [Cluster] Gets the result of an asynchronous method call. + + + + Get-SFASyncResult + + ASyncResultID + + Async Handle from a previous method call + + long + + + + KeepResult + + If true, GetAsyncResult does not remove the asynchronous result upon returning it, enabling future queries to that asyncHandle. Default is false. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ASyncResultID + + Async Handle from a previous method call + + long + + long + + + + + KeepResult + + If true, GetAsyncResult does not remove the asynchronous result upon returning it, enabling future queries to that asyncHandle. Default is false. + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64 + + + + + + + + + + + + + GetAsyncResultRequest + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetAsyncResultRequest.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFASyncResult -ASyncResultID 34 + Gets the status of the async job with ASyncResultID 34. -Jobs still in process with return a status of "running". When complete the status will change to "complete". - - - - - - - Get-SFAsyncStatus - - Gets the results of all currently running and completed asynchronous methods on the system. - - - - - Get - SFAsyncStatus - - - - Gets the results of all currently running and completed asynchronous methods on the system. - - - - AsyncResultTypes - - An optional list of types of results. You can use this list to restrict the results to only these types of operations. Possible values:BulkVolume: Copy operations between volumes, such as backups or restores.Clone: Volume cloning operations.DriveRemoval: Operations involving the system copying data from a drive in preparation to remove it from the cluster.RtfiPendingNode: Operations involving the system installing compatible software on a node before adding it to the cluster. - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Gets the results of all currently running and completed asynchronous methods on the system. - - - - - - - You can use ListAsyncResults to list the results of all currently running and completed asynchronous methods on the system. Querying asynchronous results with ListAsyncResults does not cause completed asyncHandles to expire; you can use GetAsyncResult to query any of the asyncHandles returned by ListAsyncResults. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFAsyncStatus - - Lists all currently running and completed asynchronous methods on the system with no filtering. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFAsyncStatus -AsyncResultTypes: RtfiPendingNode,BulkVolume - - Filtering results to node preparation or bulk copying operations. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFAsyncStatus -AsyncResultTypes: Clone,DriveRemoval - - Filtering results to volume cloning or drive removal preparation operations. - - - - - - - Get-SFBootstrapConfig - - [Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node. - - - - - Get - SFBootstrapConfig - - - - [Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node. - - - - - - - - - - GetBootstrapConfigResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetBootstrapConfigResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFBootstrapConfig - - - - - - - - - Get-SFBulkVolumeJob - - [Cluster] Gets information about each bulk volume read and write operation occuring in the system. - - - - - Get - SFBulkVolumeJob - - - - [Cluster] Gets information about each bulk volume read and write operation occuring in the system. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Volume - - Please specify volume object(s) - - Volume[] - - Volume[] - - - - - - VolumeID - - Enter a volume ID or list of volume IDs - - long[] - - long[] - - - - - - - - - SolidFire.Element.Api.Volume[] -System.Int64[] - - - - - [Cluster] Gets information about each bulk volume read and write operation occuring in the system. - - - - - - - - - - BulkVolumeJob[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_BulkVolumeJob.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFBulkVolumeJob - - Gets all bulk volume jobs executing on the system. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFBulkVolumeJob -VolumeID 3 - - Lists bulk volume jobs for the specified volume(s). - - - - - - - Get-SFClusterAdmin - - [Cluster] Gets a list of all cluster administrators for the cluster. - - - - - Get - SFClusterAdmin - - - - [Cluster] Gets a list of all cluster administrators for the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets a list of all cluster administrators for the cluster. - - - - - - - - - - ClusterAdmin[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterAdmin - - Gets all cluster admins configured on the cluster. - - - - - - - Get-SFClusterCapacity - - [Cluster] Gets high-level capacity measurements of an entire cluster. - - - - - Get - SFClusterCapacity - - - - [Cluster] Gets high-level capacity measurements of an entire cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets high-level capacity measurements of an entire cluster. - - - - - - - - - - ClusterCapacity - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterCapacity.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterCapacity - - - - - - - - - Get-SFClusterConfig - - [Node] Gets the cluster configuration of a node. - - - - - Get - SFClusterConfig - - - - [Node] Gets the cluster configuration of a node. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Gets the cluster configuration of a node. - - - - - - - - - - ClusterConfig - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterConfig.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterConfig - - - - - - - - - Get-SFClusterFault - - [Cluster] Gets information about faults detected on the cluster. - - - - - Get - SFClusterFault - - - - [Cluster] Gets information about faults detected on the cluster. - - - - FaultType - - Specify the fault type to retrieve faults on. - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.String[] - - - - - [Cluster] Gets information about faults detected on the cluster. - - - - - - - - - - ClusterFaultInfo[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterFaultInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterFault - - Gets all cluster faults, both active and resolved. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFClusterFault -FaultType current - - Retrieves only current (un-resolved) cluster faults. - - - - - - - Get-SFClusterFullThreshold - - [Cluster] Gets cluster fullness levels. - - - - - Get - SFClusterFullThreshold - - - - [Cluster] Gets cluster fullness levels. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets cluster fullness levels. - - - - - - - - - - GetClusterFullThresholdResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterFullThresholdResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterFullThreshold - - - - - - - - - Get-SFClusterHardwareInfo - - Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. - - - - - Get - SFClusterHardwareInfo - - - - Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Type - - Include only a certain type of hardware information in the response. Can be either "drives", "nodes", or "all". If this parameter is omitted, a type of "all" is assumed. - - string - - string - - - - - - - - - None - - - - - Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterHardwareInfo - - Outputs unfiltered results. By default the '-type all' flag is set without needing to add it manually. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFClusterHardwareInfo -Type nodes - - Outputs information for nodes. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFClusterHardwareInfo -Type drives - - Outputs information for drives. - - - - - - - Get-SFClusterInfo - - [Cluster] Gets configuration information about the cluster. - - - - - Get - SFClusterInfo - - - - [Cluster] Gets configuration information about the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets configuration information about the cluster. - - - - - - - - - - ClusterInfo - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterInfo - - - - - - - - - Get-SFClusterMasterNodeID - - [Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP). - - - - - Get - SFClusterMasterNodeID - - - - [Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP). - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP). - - - - - - - - - - GetClusterMasterNodeIDResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterMasterNodeIDResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterMasterNodeID - - - - - - - - - Get-SFClusterPair - - [Cluster] Lists all of the clusters a cluster is paired with. - - - - - Get - SFClusterPair - - - - [Cluster] Lists all of the clusters a cluster is paired with. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Lists all of the clusters a cluster is paired with. - - - - - - - - - - PairedCluster[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PairedCluster.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterPair - - - - - - - - - Get-SFClusterState - - [Node] Gets the state of nodes within Cluster. - - - - - Get - SFClusterState - - - - [Node] Gets the state of nodes within Cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Gets the state of nodes within Cluster. - - - - - - - - - - GetClusterStateResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterStateResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterState - - - - - - - - - Get-SFClusterStats - - [Cluster] Gets high-level activity measurements for the cluster. - - - - - Get - SFClusterStats - - - - [Cluster] Gets high-level activity measurements for the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets high-level activity measurements for the cluster. - - - - - - - - - - ClusterStats - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterStats.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterStats - - - - - - - - - Get-SFClusterVersionInfo - - [Cluster] Gets information about the Element OS software running on each node in the cluster. - - - - - Get - SFClusterVersionInfo - - - - [Cluster] Gets information about the Element OS software running on each node in the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets information about the Element OS software running on each node in the cluster. - - - - - - - - - - GetClusterVersionInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterVersionInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFClusterVersionInfo - - - - - - - - - Get-SFCompleteStats - - [Cluster] Used by SolidFire engineering to troubleshoot new features. - - - - - Get - SFCompleteStats - - - - [Cluster] Used by SolidFire engineering to troubleshoot new features. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Used by SolidFire engineering to troubleshoot new features. - - - - - - - - - - Hashtable - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFCompleteStats - - - - - - - - - Get-SFConfig - - [Node] Gets the network and cluster configuration of a node. - - - - - Get - SFConfig - - - - [Node] Gets the network and cluster configuration of a node. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Gets the network and cluster configuration of a node. - - - - - - - - - - Config - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Config.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFConfig - - - - - - - - - Get-SFCurrentClusterAdmin - - [Cluster] Gets user information for the current cluster administrator. - - - - - Get - SFCurrentClusterAdmin - - - - [Cluster] Gets user information for the current cluster administrator. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets user information for the current cluster administrator. - - - - - - - - - - ClusterAdmin - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFCurrentClusterAdmin - - Tells you which cluster admin you are currently running commands as. - - - - - - - Get-SFDefaultQoS - - [Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied. - - - - - Get - SFDefaultQoS - - - - [Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied. - - - - - - - - - - QoS - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_QoS.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFDefaultQoS - - - - - - - - - Get-SFDeletedVolume - - [Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system. - - - - - Get - SFDeletedVolume - - - - [Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system. - - - - Name - - Enter a volume name or list of volume names - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Enter a volume ID or list of volume IDs - - long[] - - long[] - - - - - - - - - System.Int64[] -System.String[] - - - - - [Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system. - - - - - - - - - - Volume[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFDeletedVolume - - Gets all deleted volumes on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFDeletedVolume -VolumeID 14,19,27 - - Gets only volumes 14, 19 and 27. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFDeletedVolume -Name "*Cluster*" - - Gets a list of deleted volumes that have "Cluster" in the name. - - - - - - - Get-SFDrive - - [Cluster] Gets a list of drives that exists in the cluster's active nodes. - - - - - Get - SFDrive - - - - [Cluster] Gets a list of drives that exists in the cluster's active nodes. - - - - DriveID - - Enter a drive ID or list of drive IDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Status - - Filter the returned drives by one or more Status values. Valid values are: active, available, erasing, failed, removing. - - string[] - - string[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets a list of drives that exists in the cluster's active nodes. - - - - - - - - - - DriveInfo[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFDrive - - Gets information about all drives in the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFDrive -DriveID 15 - - Gets information about only the specified drive(s). - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFDrive -Status available - - Gets all drives whose status is currently "available". - - - - - - - Get-SFDriveConfig - - [Node] Gets drive information for each drive in the node. - - - - - Get - SFDriveConfig - - - - [Node] Gets drive information for each drive in the node. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Node] Gets drive information for each drive in the node. - - - - - - - - - - DriveConfigInfo - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveConfigInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFDriveConfig - - - - - - - - - Get-SFDriveHardwareInfo - - [Cluster] Gets hardware information for a specified drive. - - - - - Get - SFDriveHardwareInfo - - - - [Cluster] Gets hardware information for a specified drive. - - - - DriveID - - Enter a drive ID, or list of Drive IDs. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets hardware information for a specified drive. - - - - - - - - - - DriveHardwareInfo - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveHardwareInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFDriveHardwareInfo -DriveID 14,18 - - Gets drive hardware info for drive ID(s). - - - - - - - Get-SFDriveStats - - [Cluster] Gets high-level activity measurements for a SolidFire drive. - - - - - Get - SFDriveStats - - - - [Cluster] Gets high-level activity measurements for a SolidFire drive. - - - - DriveID - - Enter a drive ID - - long - - long - - - - - - DriveIDs - - Enter a drive ID or list of drive IDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64 - - - - - [Cluster] Gets high-level activity measurements for a SolidFire drive. - - - - - - - - - - DriveStats - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveStats.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFDriveStats -DriveID 15 - - Gets stats about drive ID 15. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFDriveStats -DriveIDs 15,16,17,19 - - Gets stats about drives with IDs 15,16,17,19. - - - - - - - Get-SFEvent - - [Cluster] Gets events detected on the cluster. - - - - - Get - SFEvent - - - - [Cluster] Gets events detected on the cluster. - - - - EndEventID - - Enter an ending event ID - - long - - long - - - - - - MaxEvents - - Enter the maximum number of events to return - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - StartEventID - - Enter a starting event ID - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64 - - - - - [Cluster] Gets events detected on the cluster. - - - - - - - - - - EventInfo[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EventInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFEvent - - Gets all events stored on the cluster. The cluster will store ~4,000 of the most recent events. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFEvent -StartEventID 1000 -EndEventID 2000 - - Gets events with IDs between 1000 and 2000 inclusive. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFEvent -MaxEvents 10 - - Gets the 10 most recent events ordered by EventID descending. - - - - - - - Get-SFFeatureStatus - - Gets the status of a cluster feature. - - - - - Get - SFFeatureStatus - - - - Gets the status of a cluster feature. - - - - Feature - - Valid values: vvols: Find the status of the Virtual Volumes (VVOLs) cluster feature. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Gets the status of a cluster feature. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFFeatureStatus - - Checks the status of the Virtual Volumes (VVols) cluster feature. By default the command automatically choses check that feature without needing the "-Feature" flag. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFFeatureStatus -Feature vvols - - Gets the status of 'VVols' cluster feature. By default the "-Feature vvols" is not needed to check "VVols" status. - - - - - - - Get-SFFibreChannelPortInfo - - [Cluster] Gets information about Fibre Channel ports on all nodes in a cluster. - - - - - Get - SFFibreChannelPortInfo - - - - [Cluster] Gets information about Fibre Channel ports on all nodes in a cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets information about Fibre Channel ports on all nodes in a cluster. - - - - - - - - - - ListFibreChannelPortInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListFibreChannelPortInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFFibreChannelPortInfo - - - - - - - - - Get-SFFibreChannelSession - - [Cluster] Gets information about the active Fibre Channel sessions on a cluster. - - - - - Get - SFFibreChannelSession - - - - [Cluster] Gets information about the active Fibre Channel sessions on a cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets information about the active Fibre Channel sessions on a cluster. - - - - - - - - - - FibreChannelSession[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_FibreChannelSession.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFFibreChannelSession - - - - - - - - - Get-SFGroupSnapshot - - [Cluster] Gets information about all group snapshots that have been created. - - - - - Get - SFGroupSnapshot - - - - [Cluster] Gets information about all group snapshots that have been created. - - - - GroupSnapshotID - - Enter a group snapshot ID or list of group snapshot IDs - - long[] - - long[] - - - - - - GroupSnapshotName - - Enter a snapshot name or list of snapshot names - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Volume - - Please specify volume object(s) - - Volume[] - - Volume[] - - - - - - VolumeID - - An array of unique volume IDs to query. - - long[] - - long[] - - - - - - - - - System.Int64[] -System.String[] -SolidFire.Element.Api.Volume[] - - - - - [Cluster] Gets information about all group snapshots that have been created. - - - - - - - - - - GroupSnapshot - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFGroupSnapshot - - Gets all group snapshots on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFGroupSnapshot -GroupSnapshotName "VMware*" - - Return only group snapshots with names that begin with "VMware". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolume -Name "*Cluster*" | Get-SFGroupSnapshot - - Return a list of group snapshots associated with all volumes with names that include "Cluster". - - - - - - - Get-SFHardwareConfig - - Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later. - - - - - Get - SFHardwareConfig - - - - Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFHardwareConfig - - Gets the information for the connected node. - - - - - - - Get-SFHardwareInfo - - Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. - - - - - Get - SFHardwareInfo - - - - Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. - - - - - - - GetHardwareInfo allows you to return hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFHardwareInfo - - Gets the information for the connected node. - - - - - - - Get-SFInitiator - - Lists initiator IQNs or WWPNs. - - - - - Get - SFInitiator - - - - Lists initiator IQNs or WWPNs. - - - - Alias - - The friendly name to of the initiator to retrieve. - - string - - string - - - - - - InitiatorID - - The IDs of the initiators to retrieve. - - long[] - - long[] - - - - - - Name - - The name of the initiator (IQN or WWPN) to retrieve. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - The ID of the volume access group in the initiator to retrieve. - - long - - long - - - - - - - - - None - - - - - Lists initiator IQNs or WWPNs. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFInitiator - - Lists all initiators with no filtering. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFInitiator -Alias test - - Lists all initiators with alias "test". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFInitiator -Name test* - - Outputs initiator with name begining with "test". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFInitiator -InitiatorID 1 - - Outputs initiator with ID 1. - - - - - - - Get-SFIscsiSession - - [Cluster] Gets information about the iSCSI sessions for each volume. - - - - - Get - SFIscsiSession - - - - [Cluster] Gets information about the iSCSI sessions for each volume. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets information about the iSCSI sessions for each volume. - - - - - - - - - - ISCSISession[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ISCSISession.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFIscsiSession - - - - - - - - - Get-SFLdapConfiguration - - [Cluster] Gets the current LDAP configuration on cluster. - - - - - Get - SFLdapConfiguration - - - - [Cluster] Gets the current LDAP configuration on cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the current LDAP configuration on cluster. - - - - - - - - - - LdapConfiguration - http://solidfire.github.io/sdk-dotnet/help/html/P_SolidFire_Element_Api_GetLdapConfigurationResult_LdapConfiguration.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFLdapConfiguration - - - - - - - - - Get-SFLimits - - [Cluster] Gets the limit values defined on the cluster. - - - - - Get - SFLimits - - - - [Cluster] Gets the limit values defined on the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the limit values defined on the cluster. - - - - - - - - - - GetLimitsResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetLimitsResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFLimits - - - - - - - - - Get-SFLoginSessionInfo - - [Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI. - - - - - Get - SFLoginSessionInfo - - - - [Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI. - - - - - - - - - - LoginSessionInfo - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoginSessionInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFLoginSessionInfo - - - - - - - - - Get-SFLunAssignment - - [Cluster] Gets LUN mappings of a specified volume access group. - - - - - Get - SFLunAssignment - - - - [Cluster] Gets LUN mappings of a specified volume access group. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroup - - Enter a volume access group - - VolumeAccessGroup[] - - VolumeAccessGroup[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID - - long[] - - long[] - - - - - - - - - System.Int64[] -SolidFire.Element.Api.VolumeAccessGroup[] - - - - - [Cluster] Gets LUN mappings of a specified volume access group. - - - - - - - - - - VolumeAccessGroupLunAssignments - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroupLunAssignments.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFLunAssignment -VolumeAccessGroupID 1 - - Gets LUN mappings of volume access group ID 1. - - - - - - - Get-SFNetworkConfig - - [Node] Gets the network configuration of a node. - - - - - Get - SFNetworkConfig - - - - [Node] Gets the network configuration of a node. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Gets the network configuration of a node. - - - - - - - - - - Network - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Network.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFNetworkConfig - - - - - - - - - Get-SFNetworkInterface - - [Cluster] Gets information about each network interface on all nodes in a cluster. - - - - - Get - SFNetworkInterface - - - - [Cluster] Gets information about each network interface on all nodes in a cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets information about each network interface on all nodes in a cluster. - - - - - - - - - - ListNetworkInterfacesResult[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListNetworkInterfacesResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFNetworkInterface - - - - - - - - - Get-SFNodeHardwareInfo - - Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. - - - - - Get - SFNodeHardwareInfo - - - - Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. - - - - NodeID - - The ID of the node for which hardware information is being requested. Information about a node is returned if a node is specified. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64 - - - - - Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFHardwareInfo -NodeID 1 - - Gets the node information from node ID 1. - - - - - - - Get-SFNodeStats - - [Cluster] Gets the high-level activity measurements for a node or all nodes. - - - - - Get - SFNodeStats - - - - [Cluster] Gets the high-level activity measurements for a node or all nodes. - - - - NodeID - - Enter a node ID or list of node IDs. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets the high-level activity measurements for a node or all nodes. - - - - - - - - - - NodeStatsInfo[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_NodeStatsInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFNodeStats - - Gives an unfiltered list of activity measurements for all nodes in cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFNodeStats -NodeID 1 - - Lists activity measurements for nodes ID 1. - - - - - - - Get-SFNtpInfo - - [Cluster] Gets the current network time protocol (NTP) configuration information. - - - - - Get - SFNtpInfo - - - - [Cluster] Gets the current network time protocol (NTP) configuration information. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the current network time protocol (NTP) configuration information. - - - - - - - - - - GetNtpInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetNtpInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFNtpInfo - - - - - - - - - Get-SFNvramInfo - - Gets information from each node about the NVRAM card. - - - - - Get - SFNvramInfo - - - - Gets information from each node about the NVRAM card. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Gets information from each node about the NVRAM card. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFNvramInfo - - - - - - - - - Get-SFPendingNode - - [Cluster] Gets information on pending SolidFire nodes that could be added to the cluster. - - - - - Get - SFPendingNode - - - - [Cluster] Gets information on pending SolidFire nodes that could be added to the cluster. - - - - Name - - Enter a pending node name or list of pending node names. - - string[] - - string[] - - - - - - PendingNodeID - - Enter a pending node ID or list of pending node IDs. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] -System.String[] - - - - - [Cluster] Gets information on pending SolidFire nodes that could be added to the cluster. - - - - - - - - - - PendingNode[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingNode.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFPendingNode - - - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFPendingNode -PendingNodeID 1,2 - - Gets pending nodes with IDs 1 and 2. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFPendingNode -Name "SFNode*" - - Gets all pending nodes whose name begins with "SFNode". - - - - - - - Get-SFPendingOperation - - [Node] Detects an operation on a node that is currently in progress. - - - - - Get - SFPendingOperation - - - - [Node] Detects an operation on a node that is currently in progress. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Detects an operation on a node that is currently in progress. - - - - - - - - - - PendingOperation - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingOperation.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFPendingOperation - - - - - - - - - Get-SFProtocolEndpoint - - Gets protocol endpoints in the system - - - - - Get - SFProtocolEndpoint - - - +Jobs still in process with return a status of "running". When complete the status will change to "complete". + + + + + + + Get-SFAsyncStatus + + Gets the results of all currently running and completed asynchronous methods on the system. + + + + + Get + SFAsyncStatus + + + + Gets the results of all currently running and completed asynchronous methods on the system. + + + + Get-SFAsyncStatus + + AsyncResultTypes + + An optional list of types of results. You can use this list to restrict the results to only these types of operations. Possible values:BulkVolume: Copy operations between volumes, such as backups or restores.Clone: Volume cloning operations.DriveRemoval: Operations involving the system copying data from a drive in preparation to remove it from the cluster.RtfiPendingNode: Operations involving the system installing compatible software on a node before adding it to the cluster. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AsyncResultTypes + + An optional list of types of results. You can use this list to restrict the results to only these types of operations. Possible values:BulkVolume: Copy operations between volumes, such as backups or restores.Clone: Volume cloning operations.DriveRemoval: Operations involving the system copying data from a drive in preparation to remove it from the cluster.RtfiPendingNode: Operations involving the system installing compatible software on a node before adding it to the cluster. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + You can use ListAsyncResults to list the results of all currently running and completed asynchronous methods on the system. Querying asynchronous results with ListAsyncResults does not cause completed asyncHandles to expire; you can use GetAsyncResult to query any of the asyncHandles returned by ListAsyncResults. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFAsyncStatus + + Lists all currently running and completed asynchronous methods on the system with no filtering. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFAsyncStatus -AsyncResultTypes: RtfiPendingNode,BulkVolume + + Filtering results to node preparation or bulk copying operations. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFAsyncStatus -AsyncResultTypes: Clone,DriveRemoval + + Filtering results to volume cloning or drive removal preparation operations. + + + + + + + Get-SFAuthSession + + [Cluster] Gets a list of auth session on the cluster. + + + + + Get + SFAuthSession + + + + [Cluster] Gets a list of auth session on the cluster. + + + + Get-SFAuthSession + + ClusterAdminID + + ID that identifies a clusterAdmin. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFAuthSession + + Username + + Name that uniquely identifies the user. + + string + + + + AuthMethod + + Authentication method of the user sessions to be listed. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AuthMethod + + Authentication method of the user sessions to be listed. + + string + + string + + + + + ClusterAdminID + + ID that identifies a clusterAdmin. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + Name that uniquely identifies the user. + + string + + string + + + + + + + + System.Int64 +System.String + + + + + + + + + + + + + AuthSesssionInfo[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFAuthSession -ClusterAdminID 1 + + Gets list of Auth sessions by ClusterAdminID 1 + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFAuthSession -Username admin -AuthMethod Cluster + + Gets list of Auth sessions by Username admin and AuthMethod Cluster + + + + + + + Get-SFBinAssignmentProperties + + [Cluster] Enables you to retrieve the bin assignment properties in the database. + + + + + Get + SFBinAssignmentProperties + + + + [Cluster] Enables you to retrieve the bin assignment properties in the database. + + + + Get-SFBinAssignmentProperties + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + BinAssignmentProperties + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFBinAssignmentProperties + + Retrieves the bin assignment properties in the database. + + + + + + + Get-SFBootstrapConfig + + [Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node. + + + + + Get + SFBootstrapConfig + + + + [Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node. + + + + Get-SFBootstrapConfig + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + GetBootstrapConfigResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetBootstrapConfigResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFBootstrapConfig + + + + + + + + + Get-SFBulkVolumeJob + + [Cluster] Gets information about each bulk volume read and write operation occuring in the system. + + + + + Get + SFBulkVolumeJob + + + + [Cluster] Gets information about each bulk volume read and write operation occuring in the system. + + + + Get-SFBulkVolumeJob + + VolumeID + + Enter a volume ID or list of volume IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFBulkVolumeJob + + Volume + + Please specify volume object(s) + + Volume[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Volume + + Please specify volume object(s) + + Volume[] + + Volume[] + + + + + VolumeID + + Enter a volume ID or list of volume IDs + + long[] + + long[] + + + + + + + + SolidFire.Element.Api.Volume[] +System.Int64[] + + + + + + + + + + + + + BulkVolumeJob[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_BulkVolumeJob.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFBulkVolumeJob + + Gets all bulk volume jobs executing on the system. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFBulkVolumeJob -VolumeID 3 + + Lists bulk volume jobs for the specified volume(s). + + + + + + + Get-SFClientCertificateSignRequest + + [Cluster] Generates a Certificate Sign Request which can be signed by a Certificate Authority to generate a client certificate for the cluster. + + + + + Get + SFClientCertificateSignRequest + + + + [Cluster] Generates a Certificate Sign Request which can be signed by a Certificate Authority to generate a client certificate for the cluster. This is part of establishing a trust relationship for interacting with external services. + + + + Get-SFClientCertificateSignRequest + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetClientCertificateSignRequestResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClientCertificateSignRequest + + Generates a Certificate Sign Request. + + + + + + + Get-SFClusterAdmin + + [Cluster] Gets a list of all cluster administrators for the cluster. + + + + + Get + SFClusterAdmin + + + + [Cluster] Gets a list of all cluster administrators for the cluster. + + + + Get-SFClusterAdmin + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ClusterAdmin[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterAdmin + + Gets all cluster admins configured on the cluster. + + + + + + + Get-SFClusterCapacity + + [Cluster] Gets high-level capacity measurements of an entire cluster. + + + + + Get + SFClusterCapacity + + + + [Cluster] Gets high-level capacity measurements of an entire cluster. + + + + Get-SFClusterCapacity + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ClusterCapacity + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterCapacity.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterCapacity + + + + + + + + + Get-SFClusterConfig + + [Node] Gets the cluster configuration of a node. + + + + + Get + SFClusterConfig + + + + [Node] Gets the cluster configuration of a node. + + + + Get-SFClusterConfig + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ClusterConfig + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterConfig.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterConfig + + + + + + + + + Get-SFClusterFault + + [Cluster] Gets information about faults detected on the cluster. + + + + + Get + SFClusterFault + + + + [Cluster] Gets information about faults detected on the cluster. + + + + Get-SFClusterFault + + FaultType + + Specify the fault type to retrieve faults on. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + FaultType + + Specify the fault type to retrieve faults on. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.String[] + + + + + + + + + + + + + ClusterFaultInfo[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterFaultInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterFault + + Gets all cluster faults, both active and resolved. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFClusterFault -FaultType current + + Retrieves only current (un-resolved) cluster faults. + + + + + + + Get-SFClusterFullThreshold + + [Cluster] Gets cluster fullness levels. + + + + + Get + SFClusterFullThreshold + + + + [Cluster] Gets cluster fullness levels. + + + + Get-SFClusterFullThreshold + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetClusterFullThresholdResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterFullThresholdResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterFullThreshold + + + + + + + + + Get-SFClusterHardwareInfo + + Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. + + + + + Get + SFClusterHardwareInfo + + + + Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. + + + + Get-SFClusterHardwareInfo + + Type + + Include only a certain type of hardware information in the response. Can be either "drives", "nodes", or "all". If this parameter is omitted, a type of "all" is assumed. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Type + + Include only a certain type of hardware information in the response. Can be either "drives", "nodes", or "all". If this parameter is omitted, a type of "all" is assumed. + + string + + string + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterHardwareInfo + + Outputs unfiltered results. By default the '-type all' flag is set without needing to add it manually. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFClusterHardwareInfo -Type nodes + + Outputs information for nodes. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFClusterHardwareInfo -Type drives + + Outputs information for drives. + + + + + + + Get-SFClusterInfo + + [Cluster] Gets configuration information about the cluster. + + + + + Get + SFClusterInfo + + + + [Cluster] Gets configuration information about the cluster. + + + + Get-SFClusterInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ClusterInfo + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterInfo + + + + + + + + + Get-SFClusterInterfacePreference + + [Cluster] Retrieves Cluster Interface Preference(s). + + + + + Get + SFClusterInterfacePreference + + + + [Cluster] Retrieves all Cluster Interface Preferences if no parameters are given. If Name is specified then only that CIP is returned. + + + + Get-SFClusterInterfacePreference + + Name + + Value stored in the key-value store. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Name + + Value stored in the key-value store. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ListClusterInterfacePreferenceResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListClusterInterfacePreferenceResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterInterfacePreference + + Gets all CIPs. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFClusterInterfacePreference -Name "bestPet" + + Gets a single CIP. + + + + + + + Get-SFClusterMasterNodeID + + [Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP). + + + + + Get + SFClusterMasterNodeID + + + + [Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP). + + + + Get-SFClusterMasterNodeID + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetClusterMasterNodeIDResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterMasterNodeIDResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterMasterNodeID + + + + + + + + + Get-SFClusterPair + + [Cluster] Lists all of the clusters a cluster is paired with. + + + + + Get + SFClusterPair + + + + [Cluster] Lists all of the clusters a cluster is paired with. + + + + Get-SFClusterPair + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + PairedCluster[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PairedCluster.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterPair + + + + + + + + + Get-SFClusterSshInfo + + [Cluster] Returns SSH status for the cluster. + + + + + Get + SFClusterSshInfo + + + + [Cluster] Returns SSH status for the cluster. + + + + Get-SFClusterSshInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetClusterSshInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterSshInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterSshInfo + + Gets SSH info from the currently connected cluster. + + + + + + + Get-SFClusterState + + [Node] Gets the state of nodes within Cluster. + + + + + Get + SFClusterState + + + + [Node] Gets the state of nodes within Cluster. + + + + Get-SFClusterState + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetClusterStateResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterStateResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterState + + + + + + + + + Get-SFClusterStats + + [Cluster] Gets high-level activity measurements for the cluster. + + + + + Get + SFClusterStats + + + + [Cluster] Gets high-level activity measurements for the cluster. + + + + Get-SFClusterStats + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ClusterStats + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterStats.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterStats + + + + + + + + + Get-SFClusterVersionInfo + + [Cluster] Gets information about the Element OS software running on each node in the cluster. + + + + + Get + SFClusterVersionInfo + + + + [Cluster] Gets information about the Element OS software running on each node in the cluster. + + + + Get-SFClusterVersionInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetClusterVersionInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterVersionInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFClusterVersionInfo + + + + + + + + + Get-SFCompleteStats + + [Cluster] Used by SolidFire engineering to troubleshoot new features. + + + + + Get + SFCompleteStats + + + + [Cluster] Used by SolidFire engineering to troubleshoot new features. + + + + Get-SFCompleteStats + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + Hashtable + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFCompleteStats + + + + + + + + + Get-SFConfig + + [Node] Gets the network and cluster configuration of a node. + + + + + Get + SFConfig + + + + [Node] Gets the network and cluster configuration of a node. + + + + Get-SFConfig + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + Config + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Config.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFConfig + + + + + + + + + Get-SFCurrentClusterAdmin + + [Cluster] Gets user information for the current cluster administrator. + + + + + Get + SFCurrentClusterAdmin + + + + [Cluster] Gets user information for the current cluster administrator. + + + + Get-SFCurrentClusterAdmin + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ClusterAdmin + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFCurrentClusterAdmin + + Tells you which cluster admin you are currently running commands as. + + + + + + + Get-SFDefaultQoS + + [Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied. + + + + + Get + SFDefaultQoS + + + + [Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied. + + + + Get-SFDefaultQoS + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + QoS + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_QoS.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFDefaultQoS + + + + + + + + + Get-SFDeletedVolume + + [Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system. + + + + + Get + SFDeletedVolume + + + + [Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system. + + + + Get-SFDeletedVolume + + VolumeID + + Enter a volume ID or list of volume IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFDeletedVolume + + Name + + Enter a volume name or list of volume names + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Name + + Enter a volume name or list of volume names + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a volume ID or list of volume IDs + + long[] + + long[] + + + + + + + + System.Int64[] +System.String[] + + + + + + + + + + + + + Volume[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFDeletedVolume + + Gets all deleted volumes on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFDeletedVolume -VolumeID 14,19,27 + + Gets only volumes 14, 19 and 27. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFDeletedVolume -Name "*Cluster*" + + Gets a list of deleted volumes that have "Cluster" in the name. + + + + + + + Get-SFDrive + + [Cluster] Gets a list of drives that exists in the cluster's active nodes. + + + + + Get + SFDrive + + + + [Cluster] Gets a list of drives that exists in the cluster's active nodes. + + + + Get-SFDrive + + Status + + Filter the returned drives by one or more Status values. Valid values are: active, available, erasing, failed, removing. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DriveID + + Enter a drive ID or list of drive IDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Status + + Filter the returned drives by one or more Status values. Valid values are: active, available, erasing, failed, removing. + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + DriveInfo[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFDrive + + Gets information about all drives in the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFDrive -DriveID 15 + + Gets information about only the specified drive(s). + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFDrive -Status available + + Gets all drives whose status is currently "available". + + + + + + + Get-SFDriveConfig + + [Node] Gets drive information for each drive in the node. + + + + + Get + SFDriveConfig + + + + [Node] Gets drive information for each drive in the node. + + + + Get-SFDriveConfig + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DriveConfigInfo + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveConfigInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFDriveConfig + + + + + + + + + Get-SFDriveHardwareInfo + + [Cluster] Gets hardware information for a specified drive. + + + + + Get + SFDriveHardwareInfo + + + + [Cluster] Gets hardware information for a specified drive. + + + + Get-SFDriveHardwareInfo + + DriveID + + Enter a drive ID, or list of Drive IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DriveID + + Enter a drive ID, or list of Drive IDs. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + DriveHardwareInfo + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveHardwareInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFDriveHardwareInfo -DriveID 14,18 + + Gets drive hardware info for drive ID(s). + + + + + + + Get-SFDriveStats + + [Cluster] Gets high-level activity measurements for a SolidFire drive. + + + + + Get + SFDriveStats + + + + [Cluster] Gets high-level activity measurements for a SolidFire drive. + + + + Get-SFDriveStats + + DriveIDs + + Enter a drive ID or list of drive IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFDriveStats + + DriveID + + Enter a drive ID + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DriveID + + Enter a drive ID + + long + + long + + + + + DriveIDs + + Enter a drive ID or list of drive IDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64 + + + + + + + + + + + + + DriveStats + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveStats.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFDriveStats -DriveID 15 + + Gets stats about drive ID 15. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFDriveStats -DriveIDs 15,16,17,19 + + Gets stats about drives with IDs 15,16,17,19. + + + + + + + Get-SFEncryptionAtRestInfo + + [Cluster] Get details of the current Encryption At Rest configuration. Encryption At Rest feature is built upon the Self-Encrypting Drive's hardware encryption capability. + + + + + Get + SFEncryptionAtRestInfo + + + + [Cluster] Get details of the current Encryption At Rest configuration. + + + + Get-SFEncryptionAtRestInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetEncryptionAtRestInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetEncryptionAtRestInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFEncryptionAtRestInfo + + Get details of the current Encryption At Rest configuration. + + + + + + + Get-SFEvent + + [Cluster] Gets events detected on the cluster. + + + + + Get + SFEvent + + + + [Cluster] Gets events detected on the cluster. + + + + Get-SFEvent + + StartEventID + + Enter a starting event ID + + long + + + + EndEventID + + Enter an ending event ID + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFEvent + + MaxEvents + + Enter the maximum number of events to return + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + EndEventID + + Enter an ending event ID + + long + + long + + + + + MaxEvents + + Enter the maximum number of events to return + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StartEventID + + Enter a starting event ID + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64 + + + + + + + + + + + + + EventInfo[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EventInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFEvent + + Gets all events stored on the cluster. The cluster will store ~4,000 of the most recent events. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFEvent -StartEventID 1000 -EndEventID 2000 + + Gets events with IDs between 1000 and 2000 inclusive. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFEvent -MaxEvents 10 + + Gets the 10 most recent events ordered by EventID descending. + + + + + + + Get-SFFeatureStatus + + Gets the status of a cluster feature. + + + + + Get + SFFeatureStatus + + + + Gets the status of a cluster feature. + + + + Get-SFFeatureStatus + + Feature + + Valid values: vvols: Find the status of the Virtual Volumes (VVOLs) cluster feature. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Feature + + Valid values: vvols: Find the status of the Virtual Volumes (VVOLs) cluster feature. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFFeatureStatus + + Checks the status of the Virtual Volumes (VVols) cluster feature. By default the command automatically choses check that feature without needing the "-Feature" flag. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFFeatureStatus -Feature vvols + + Gets the status of 'VVols' cluster feature. By default the "-Feature vvols" is not needed to check "VVols" status. + + + + + + + Get-SFFibreChannelPortInfo + + [Cluster] Gets information about Fibre Channel ports on all nodes in a cluster. + + + + + Get + SFFibreChannelPortInfo + + + + [Cluster] Gets information about Fibre Channel ports on all nodes in a cluster. + + + + Get-SFFibreChannelPortInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListFibreChannelPortInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListFibreChannelPortInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFFibreChannelPortInfo + + + + + + + + + Get-SFFibreChannelSession + + [Cluster] Gets information about the active Fibre Channel sessions on a cluster. + + + + + Get + SFFibreChannelSession + + + + [Cluster] Gets information about the active Fibre Channel sessions on a cluster. + + + + Get-SFFibreChannelSession + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + FibreChannelSession[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_FibreChannelSession.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFFibreChannelSession + + + + + + + + + Get-SFGroupSnapshot + + [Cluster] Gets information about all group snapshots that have been created. + + + + + Get + SFGroupSnapshot + + + + [Cluster] Gets information about all group snapshots that have been created. + + + + Get-SFGroupSnapshot + + GroupSnapshotID + + Enter a group snapshot ID or list of group snapshot IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFGroupSnapshot + + GroupSnapshotName + + Enter a snapshot name or list of snapshot names + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFGroupSnapshot + + VolumeID + + An array of unique volume IDs to query. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFGroupSnapshot + + Volume + + Please specify volume object(s) + + Volume[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + GroupSnapshotID + + Enter a group snapshot ID or list of group snapshot IDs + + long[] + + long[] + + + + + GroupSnapshotName + + Enter a snapshot name or list of snapshot names + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Volume + + Please specify volume object(s) + + Volume[] + + Volume[] + + + + + VolumeID + + An array of unique volume IDs to query. + + long[] + + long[] + + + + + + + + System.Int64[] +System.String[] +SolidFire.Element.Api.Volume[] + + + + + + + + + + + + + GroupSnapshot + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFGroupSnapshot + + Gets all group snapshots on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFGroupSnapshot -GroupSnapshotName "VMware*" + + Return only group snapshots with names that begin with "VMware". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolume -Name "*Cluster*" | Get-SFGroupSnapshot + + Return a list of group snapshots associated with all volumes with names that include "Cluster". + + + + + + + Get-SFHardwareConfig + + Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later. + + + + + Get + SFHardwareConfig + + + + Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later. + + + + Get-SFHardwareConfig + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFHardwareConfig + + Gets the information for the connected node. + + + + + + + Get-SFHardwareInfo + + Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. + + + + + Get + SFHardwareInfo + + + + Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. + + + + Get-SFHardwareInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + GetHardwareInfo allows you to return hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFHardwareInfo + + Gets the information for the connected node. + + + + + + + Get-SFIdpAuthenticationState + + [Cluster] Return information regarding the state of authentication using third party Identity Providers. + + + + + Get + SFIdpAuthenticationState + + + + [Cluster] Return information regarding the state of authentication using third party Identity Providers. + + + + Get-SFIdpAuthenticationState + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetIdpAuthenticationStateResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFIdpAuthenticationState + + Gets IDP Authentication State of the cluster + + + + + + + Get-SFIdpConfiguration + + [Cluster] List configurations for third party Identity Provider(s) (IdP), optionally providing either enabledOnly flag to retrieve the currently enabled IdP configuration, or an IdP metadata UUID or IdP name to query a specific IdP configuration information. + + + + + Get + SFIdpConfiguration + + + + [Cluster] List configurations for third party Identity Provider(s) (IdP), optionally providing either enabledOnly flag to retrieve the currently enabled IdP configuration, or an IdP metadata UUID or IdP name to query a specific IdP configuration information. + + + + Get-SFIdpConfiguration + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFIdpConfiguration + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFIdpConfiguration + + IdpName + + Filters the result to an IdP configuration information for a specific IdP name. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFIdpConfiguration + + EnabledOnly + + Filters the result to return the currently enabled Idp configuration. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + EnabledOnly + + Filters the result to return the currently enabled Idp configuration. + + + switch + + + + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + guid + + + + + IdpName + + Filters the result to an IdP configuration information for a specific IdP name. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Guid +System.String +System.Management.Automation.SwitchParameter + + + + + + + + + + + + + IdpConfigInfo[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFIdpConfiguration + + Gets List of IDP Configurations configured on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFIdpConfiguration -IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a + + Gets IDP Configuration configured on the cluster with IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFIdpConfiguration -IdpName adfsidp + + Gets IDP Configurations configured on the cluster with IdpName adfsidp. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFIdpConfiguration -EnabledOnly + + Gets IDP Configurations configured on the cluster which are enabled. + + + + + + + Get-SFInitiator + + Lists initiator IQNs or WWPNs. + + + + + Get + SFInitiator + + + + Lists initiator IQNs or WWPNs. + + + + Get-SFInitiator + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFInitiator + + InitiatorID + + The IDs of the initiators to retrieve. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFInitiator + + Name + + The name of the initiator (IQN or WWPN) to retrieve. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFInitiator + + Alias + + The friendly name to of the initiator to retrieve. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFInitiator + + VolumeAccessGroupID + + The ID of the volume access group in the initiator to retrieve. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Alias + + The friendly name to of the initiator to retrieve. + + string + + string + + + + + InitiatorID + + The IDs of the initiators to retrieve. + + long[] + + long[] + + + + + Name + + The name of the initiator (IQN or WWPN) to retrieve. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + The ID of the volume access group in the initiator to retrieve. + + long + + long + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFInitiator + + Lists all initiators with no filtering. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFInitiator -Alias test + + Lists all initiators with alias "test". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFInitiator -Name test* + + Outputs initiator with name begining with "test". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFInitiator -InitiatorID 1 + + Outputs initiator with ID 1. + + + + + + + Get-SFIscsiSession + + [Cluster] Gets information about the iSCSI sessions for each volume. + + + + + Get + SFIscsiSession + + + + [Cluster] Gets information about the iSCSI sessions for each volume. + + + + Get-SFIscsiSession + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ISCSISession[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ISCSISession.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFIscsiSession + + + + + + + + + Get-SFKeyProviderKmip + + [Cluster] Gets a list of KMIP (Key Management Interoperability Protocol) Key Providers on the cluster. + + + + + Get + SFKeyProviderKmip + + + + [Cluster] Gets the list of KMIP (Key Management Interoperability Protocol) Key Providers which have been created via CreateKeyProviderKmip. The list can optionally be filtered by specifying additional parameters. + + + + Get-SFKeyProviderKmip + + KeyProviderIsActive + + If omitted, returned KMIP Key Provider objects will not be filtered based on whether they're active. If true, returns only KMIP Key Provider objects which are active (providing keys which are currently in use). If false, returns only KMIP Key Provider objects which are inactive (not providing any keys and able to be deleted). + + bool + + + + KmipKeyProviderHasServerAssigned + + If omitted, returned KMIP Key Provider objects will not be filtered based on whether they have a KMIP Key Server assigned. If true, returns only KMIP Key Provider objects which have a KMIP Key Server assigned. If false, returns only KMIP Key Provider objects which do not have a KMIP Key Server assigned. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFKeyProviderKmip + + KeyProviderID + + The ID of the KMIP Key Provider object to return. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyProviderID + + The ID of the KMIP Key Provider object to return. + + long + + long + + + + + KeyProviderIsActive + + If omitted, returned KMIP Key Provider objects will not be filtered based on whether they're active. If true, returns only KMIP Key Provider objects which are active (providing keys which are currently in use). If false, returns only KMIP Key Provider objects which are inactive (not providing any keys and able to be deleted). + + bool + + bool + + + + + KmipKeyProviderHasServerAssigned + + If omitted, returned KMIP Key Provider objects will not be filtered based on whether they have a KMIP Key Server assigned. If true, returns only KMIP Key Provider objects which have a KMIP Key Server assigned. If false, returns only KMIP Key Provider objects which do not have a KMIP Key Server assigned. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + KeyProviderKmip[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFKeyProviderKmip -KeyProviderID 1 + + Gets the Key Provider based on its ID. + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFKeyProviderKmip -KeyProviderIsActive $true + + Gets all active Key Providers + + + + + + + Get-SFKeyServerKmip + + [Cluster] Gets a list of KMIP (Key Management Interoperability Protocol) Key Providers on the cluster. + + + + + Get + SFKeyServerKmip + + + + [Cluster] Gets the list of KMIP (Key Management Interoperability Protocol) Key Servers which have been created via CreateKeyServerKmip. The list can optionally be filtered by specifying additional parameters. + + + + Get-SFKeyServerKmip + + KeyProviderID + + If omitted, returned KMIP Key Server objects will not be filtered based on whether they're assigned to the specified KMIP Key Provider. If specified, returned KMIP Key Server objects will be filtered to those assigned to the specified KMIP Key Provider. + + long + + + + KmipAssignedProviderIsActive + + If omitted, returned KMIP Key Server objects will not be filtered based on whether they're active. If true, returns only KMIP Key Server objects which are active (providing keys which are currently in use). If false, returns only KMIP Key Server objects which are inactive (not providing any keys and able to be deleted). + + bool + + + + KmipHasProviderAssigned + + If omitted, returned KMIP Key Server objects will not be filtered based on whether they have a KMIP Key Provider assigned. If true, returns only KMIP Key Server objects which have a KMIP Key Provider assigned. If false, returns only KMIP Key Server objects which do not have a KMIP Key Provider assigned. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFKeyServerKmip + + KeyServerID + + The ID of the KMIP Key Server object to return. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyProviderID + + If omitted, returned KMIP Key Server objects will not be filtered based on whether they're assigned to the specified KMIP Key Provider. If specified, returned KMIP Key Server objects will be filtered to those assigned to the specified KMIP Key Provider. + + long + + long + + + + + KeyServerID + + The ID of the KMIP Key Server object to return. + + long + + long + + + + + KmipAssignedProviderIsActive + + If omitted, returned KMIP Key Server objects will not be filtered based on whether they're active. If true, returns only KMIP Key Server objects which are active (providing keys which are currently in use). If false, returns only KMIP Key Server objects which are inactive (not providing any keys and able to be deleted). + + bool + + bool + + + + + KmipHasProviderAssigned + + If omitted, returned KMIP Key Server objects will not be filtered based on whether they have a KMIP Key Provider assigned. If true, returns only KMIP Key Server objects which have a KMIP Key Provider assigned. If false, returns only KMIP Key Server objects which do not have a KMIP Key Provider assigned. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + KeyServerKmip[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFKeyServerKmip -KeyProviderID 1 + + Gets all key servers associated with Key Provider ID + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFKeyProviderKmip -KeyServerID 1 + + Gets the Key Server with the specified ID + + + + + + + Get-SFLdapConfiguration + + [Cluster] Gets the current LDAP configuration on cluster. + + + + + Get + SFLdapConfiguration + + + + [Cluster] Gets the current LDAP configuration on cluster. + + + + Get-SFLdapConfiguration + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + LdapConfiguration + http://solidfire.github.io/sdk-dotnet/help/html/P_SolidFire_Element_Api_GetLdapConfigurationResult_LdapConfiguration.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFLdapConfiguration + + + + + + + + + Get-SFLicenseKey + + [Cluster] Gets the current license key. + + + + + Get + SFLicenseKey + + + + [Cluster] Gets the current license key + + + + Get-SFLicenseKey + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetLicenseKeyResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetLicenseKey.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFLicenseKey + + Gets the current license key. + + + + + + + Get-SFLimits + + [Cluster] Gets the limit values defined on the cluster. + + + + + Get + SFLimits + + + + [Cluster] Gets the limit values defined on the cluster. + + + + Get-SFLimits + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetLimitsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetLimitsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFLimits + + + + + + + + + Get-SFLoginBanner + + [Cluster] Gets the login banner text and status. + + + + + Get + SFLoginBanner + + + + [Cluster] Gets the login banner text and status. + + + + Get-SFLoginBanner + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFLoginBanner + + Gets the login banner text and status. + + + + + + + Get-SFLoginSessionInfo + + [Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI. + + + + + Get + SFLoginSessionInfo + + + + [Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI. + + + + Get-SFLoginSessionInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + LoginSessionInfo + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoginSessionInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFLoginSessionInfo + + + + + + + + + Get-SFLunAssignment + + [Cluster] Gets LUN mappings of a specified volume access group. + + + + + Get + SFLunAssignment + + + + [Cluster] Gets LUN mappings of a specified volume access group. + + + + Get-SFLunAssignment + + VolumeAccessGroupID + + Enter a volume access group ID + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFLunAssignment + + VolumeAccessGroup + + Enter a volume access group + + VolumeAccessGroup[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroup + + Enter a volume access group + + VolumeAccessGroup[] + + VolumeAccessGroup[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID + + long[] + + long[] + + + + + + + + System.Int64[] +SolidFire.Element.Api.VolumeAccessGroup[] + + + + + + + + + + + + + VolumeAccessGroupLunAssignments + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroupLunAssignments.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFLunAssignment -VolumeAccessGroupID 1 + + Gets LUN mappings of volume access group ID 1. + + + + + + + Get-SFNetworkConfig + + [Node] Gets the network configuration of a node. + + + + + Get + SFNetworkConfig + + + + [Node] Gets the network configuration of a node. + + + + Get-SFNetworkConfig + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + Network + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Network.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNetworkConfig + + + + + + + + + Get-SFNetworkInterface + + [Cluster] Gets information about each network interface on all nodes in a cluster. + + + + + Get + SFNetworkInterface + + + + [Cluster] Gets information about each network interface on all nodes in a cluster. + + + + Get-SFNetworkInterface + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListNetworkInterfacesResult[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListNetworkInterfacesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNetworkInterface + + + + + + + + + Get-SFNetworkInterfaceStats + + [Node] List statistics for network statistics such as dropped packets and various types of errors. + + + + + Get + SFNetworkInterfaceStats + + + + [Node] List statistics for network statistics such as dropped packets and various types of errors. + + + + Get-SFNetworkInterfaceStats + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + NetworkInterfaceStats + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_NetworkInterfaceStats.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNetworkInterfaceStats + + List statistics for network statistics such as dropped packets and various types of errors. + + + + + + + Get-SFNodeActiveTlsCiphers + + [Node] Get-SFNodeActiveTlsCiphers gets a list of the TLS ciphers that are currently accepted on the node. + + + + + Get + SFNodeActiveTlsCiphers + + + + [Node] Get-SFNodeActiveTlsCiphers gets a list of the TLS ciphers that are currently accepted on the node. + + + + Get-SFNodeActiveTlsCiphers + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetNodeActiveTlsCiphersResult + + + + + + + + + Get-SFNodeFipsDrivesReport + + [Node] Reports the FipsDrives capability of a node. + + + + + Get + SFNodeFipsDrivesReport + + + + [Node] Reports the FipsDrives capability of a node. + + + + Get-SFNodeFipsDrivesReport + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetNodeFipsDriveReportResult + + + + + + + + + Get-SFNodeHardwareInfo + + Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. + + + + + Get + SFNodeHardwareInfo + + + + Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information. + + + + Get-SFNodeHardwareInfo + + NodeID + + The ID of the node for which hardware information is being requested. Information about a node is returned if a node is specified. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + NodeID + + The ID of the node for which hardware information is being requested. Information about a node is returned if a node is specified. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64 + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFHardwareInfo -NodeID 1 + + Gets the node information from node ID 1. + + + + + + + Get-SFNodeSSLCertificate + + [Node] Gets the management node's SSL certificate. + + + + + Get + SFNodeSSLCertificate + + + + [Node] Gets the management node's SSL certificate. + + + + Get-SFNodeSSLCertificate + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNodeSSLCertificate + + Gets the management node's SSL certificate. + + + + + + + Get-SFNodeStats + + [Cluster] Gets the high-level activity measurements for a node or all nodes. + + + + + Get + SFNodeStats + + + + [Cluster] Gets the high-level activity measurements for a node or all nodes. + + + + Get-SFNodeStats + + NodeID + + Enter a node ID or list of node IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + NodeID + + Enter a node ID or list of node IDs. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + NodeStatsInfo[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_NodeStatsInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNodeStats + + Gives an unfiltered list of activity measurements for all nodes in cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFNodeStats -NodeID 1 + + Lists activity measurements for nodes ID 1. + + + + + + + Get-SFNodeSupportedTlsCiphers + + [Node] Get-SFNodeSupportedTlsCiphers gets a list of the supported TLS ciphers. + + + + + Get + SFNodeSupportedTlsCiphers + + + + [Node] Get-SFNodeSupportedTlsCiphers gets a list of the supported TLS ciphers. + + + + Get-SFNodeSupportedTlsCiphers + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetNodeSupportedTlsCiphersResult + + + + + + + + + Get-SFNtpInfo + + [Cluster] Gets the current network time protocol (NTP) configuration information. + + + + + Get + SFNtpInfo + + + + [Cluster] Gets the current network time protocol (NTP) configuration information. + + + + Get-SFNtpInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetNtpInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetNtpInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNtpInfo + + + + + + + + + Get-SFNvramInfo + + Gets information from each node about the NVRAM card. + + + + + Get + SFNvramInfo + + + + Gets information from each node about the NVRAM card. + + + + Get-SFNvramInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFNvramInfo + + + + + + + + + Get-SFOntapVersionInfo + + [Cluster] Get-SFOntapVersionInfo gets information about API version support from the ONTAP cluster in a SnapMirror relationship. + + + + + Get + SFOntapVersionInfo + + + + [Cluster] Get-SFOntapVersionInfo gets information about API version support from the ONTAP cluster in a SnapMirror relationship. + + + + Get-SFOntapVersionInfo + + SnapMirrorEndpointID + + If provided, the system lists the version information from the endpoint with the specified snapMirrorEndpointID. If not provided, the system lists the version information of all known SnapMirror endpoints. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + If provided, the system lists the version information from the endpoint with the specified snapMirrorEndpointID. If not provided, the system lists the version information of all known SnapMirror endpoints. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetOnTapVersionInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetOnTapVersionInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFOntapVersionInfo + + Lists the OntapVersionInfo for all endpoint. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFOntapVersionInfo -SnapMirrorEndpointID 5 + + Lists the OntapVersionInfo for the endpoint with ID 5. + + + + + + + Get-SFPatchInfo + + [Node] GetPatchInfo enables you to display the details of D-patch information for the given node. + + + + + Get + SFPatchInfo + + + + [Node] GetPatchInfo enables you to display the details of D-patch information for the given node. + + + + Get-SFPatchInfo + + Force + + Force this method to run on all nodes. Only needed when issuing the API to a cluster instead of a single node. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Force + + Force this method to run on all nodes. Only needed when issuing the API to a cluster instead of a single node. + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetPatchInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetPatchInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFPatchInfo + + Gives the details of D-patch information for the given node. + + + + + + + Get-SFPendingNode + + [Cluster] Gets information on pending SolidFire nodes that could be added to the cluster. + + + + + Get + SFPendingNode + + + + [Cluster] Gets information on pending SolidFire nodes that could be added to the cluster. + + + + Get-SFPendingNode + + PendingNodeID + + Enter a pending node ID or list of pending node IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFPendingNode + + Name + + Enter a pending node name or list of pending node names. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Name + + Enter a pending node name or list of pending node names. + + string[] + + string[] + + + + + PendingNodeID + + Enter a pending node ID or list of pending node IDs. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] +System.String[] + + + + + + + + + + + + + PendingNode[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingNode.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFPendingNode + + + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFPendingNode -PendingNodeID 1,2 + + Gets pending nodes with IDs 1 and 2. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFPendingNode -Name "SFNode*" + + Gets all pending nodes whose name begins with "SFNode". + + + + + + + Get-SFPendingOperation + + [Node] Detects an operation on a node that is currently in progress. + + + + + Get + SFPendingOperation + + + + [Node] Detects an operation on a node that is currently in progress. + + + + Get-SFPendingOperation + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + PendingOperation + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingOperation.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFPendingOperation + + + + + + + + + Get-SFProtectionDomainLayout + + [Cluster] Returns all of the Protection Domain information for the cluster. + + + + + Get + SFProtectionDomainLayout + + + + [Cluster] Returns all of the Protection Domain information for the cluster. + + + + Get-SFProtectionDomainLayout + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + NodeProtectionDomains[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFProtectionDomainLayout + + Returns all of the Protection Domain information for the cluster. + + + + + + + Get-SFProtectionDomainLevels + + [Cluster] Get-SFProtectionDomainLevels returns the Tolerance and Resiliency of the cluster from the perspective of each of the supported ProtectionDomainTypes. + + + + + Get + SFProtectionDomainLevels + + + + [Cluster] Get-SFProtectionDomainLevels returns the Tolerance and Resiliency of the cluster from the perspective of each of the supported ProtectionDomainTypes. + + + + Get-SFProtectionDomainLevels + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ListProtectionDomainLevelsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListProtectionDomainLevelsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFProtectionDomainLevels + + Gets the Protection Domain information from the cluster. + + + + + + + Get-SFProtocolEndpoint + + Gets protocol endpoints in the system + + + + + Get + SFProtocolEndpoint + + + Gets protocol endpoints in the system - + If protocolEndpointIDs isn't specified all protocol endpoints - - are returned. Else the supplied protocolEndpointIDs are. - - - - ProtocolEndpointIDs - - - - guid[] - - guid[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Guid[] - - - - - Gets protocol endpoints in the system - - If protocolEndpointIDs isn't specified all protocol endpoints - - are returned. Else the supplied protocolEndpointIDs are. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFProtocolEndpoint - - Outputs all Protocol Endpoints. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - + + are returned. Else the supplied protocolEndpointIDs are. + + + + Get-SFProtocolEndpoint + + ProtocolEndpointIDs + + + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ProtocolEndpointIDs + + + + guid[] + + guid[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Guid[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFProtocolEndpoint + + Outputs all Protocol Endpoints. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $pEnd = Get-SFProtocolEndpoint -$pEnd[2] - - Saves output and prints 3rd endpoint's data. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFProtocolEndpoint -ProtocolEndpointIDs 3ffb55f2-98d1-43bd-88c6-90f939251252 - - Outputs the protocol endpoint information for selected ProtocolEndpointID. In this case, ProtocolEndpointID: "3ffb55f2-98d1-43bd-88c6-90f939251252". - - - - - - - Get-SFRawStats - - [Cluster] Used by SolidFire engineering to troubleshoot new features. - - - - - Get - SFRawStats - - - - [Cluster] Used by SolidFire engineering to troubleshoot new features. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Used by SolidFire engineering to troubleshoot new features. - - - - - - - - - - Hashtable - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFRawStats - - - - - - - - - Get-SFRemoteLoggingHost - - [Cluster] Retrieves the current list of log servers. - - - - - Get - SFRemoteLoggingHost - - - - [Cluster] Retrieves the current list of log servers. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Retrieves the current list of log servers. - - - - - - - - - - LoggingServer[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoggingServer.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFRemoteLoggingHost - - - - - - - - - Get-SFSchedule - - [Cluster] Gets the scheduled snapshots on a cluster. - - - - - Get - SFSchedule - - - - [Cluster] Gets the scheduled snapshots on a cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - ScheduleID - - Enter a schedule ID or list of schedule IDs. - - long[] - - long[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets the scheduled snapshots on a cluster. - - - - - - - - - - Schedule[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSchedule - - Lists all schedules. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFSchedule -ScheduleID 5 - - Get single Schedule by ID. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFSchedule -ScheduleID 5,6,7,8,9,10 - - Gets list of Schedules by ID. - - - - - - - Get-SFServices - - [Cluster] Lists the services running on the cluster. - - - - - Get - SFServices - - - - You can use ListServices to return the services information for nodes, drives, current software, and other services that are running on the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - You can use ListServices to return the services information for nodes, drives, current software, and other services that are running on the cluster. - - - - - - - - - - DetailedService[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DetailedService.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFServices - - - - - - - - - Get-SFSnapshot - - [Cluster] Gets the attributes of each snapshot taken on a volume. - - - - - Get - SFSnapshot - - - - [Cluster] Gets the attributes of each snapshot taken on a volume. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - Enter a snapshot ID or list of snapshot IDs. - - long[] - - long[] - - - - - - SnapshotName - - Enter a snapshot name or list of snapshot names. - - string[] - - string[] - - - - - - Target - - - - string[] - - string[] - - - - - - Volume - - Specify volume object(s) - - Volume[] - - Volume[] - - - - - - VolumeID - - Enter a volume ID or list of volume IDs. - - long[] - - long[] - - - - - - - - - System.Int64[] -System.String[] -SolidFire.Element.Api.Volume[] - - - - - [Cluster] Gets the attributes of each snapshot taken on a volume. - - - - - - - - - - Snapshot[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSnapshot - - Gets all snapshots for all volumes on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFSnapshot -SnapshotID 36 - - Gets the attributes from snapshot ID 36. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFSnapshot -SnapshotName "VMware*" - - Gets all snapshots that include "VMware" at the beginning of the snapshot name. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - - Get-SFVolume -Name "VM*" | Get-SFSnapshot - - Gets all snapshots from any volumes that inlcude "VM" at the beginning of the volume name. - - - - - - - Get-SFSnmpAcl - - [Cluster] Gets the current SNMP access permissions on cluster nodes. - - - - - Get - SFSnmpAcl - - - - [Cluster] Gets the current SNMP access permissions on cluster nodes. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the current SNMP access permissions on cluster nodes. - - - - - - - - - - GetSnmpACLResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSnmpAcl - - - - - - - - - Get-SFSnmpInfo - - [Cluster] Gets the current SNMP configuration information. - - - - - Get - SFSnmpInfo - - - - [Cluster] Gets the current SNMP configuration information. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the current SNMP configuration information. - - - - - - - - - - GetSnmpInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSnmpInfo - - - - - - - - - Get-SFSnmpState - - [Cluster] Gets the current state of the SNMP feature. - - - - - Get - SFSnmpState - - - - [Cluster] Gets the current state of the SNMP feature. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets the current state of the SNMP feature. - - - - - - - - - - GetSnmpStateResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSnmpState - - - - - - - - - Get-SFSnmpTrapInfo - - [Cluster] Gets current SNMP trap configuration information. - - - - - Get - SFSnmpTrapInfo - - - - [Cluster] Gets current SNMP trap configuration information. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets current SNMP trap configuration information. - - - - - - - - - - SFSnmpTrapInfo - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSnmpTrapInfo - - - - - - - - - Get-SFStorageContainer - - Gets information for all storage containers currently in the system. - - - - - Get - SFStorageContainer - - - - Gets information for all storage containers currently in the system. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - StorageContainerID - - List of storage containers to get - - guid[] - - guid[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Guid[] - - - - - Gets information for all storage containers currently in the system. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFStorageContainer - - Gets information an all storage contains. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +$pEnd[2] + + Saves output and prints 3rd endpoint's data. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFProtocolEndpoint -ProtocolEndpointIDs 3ffb55f2-98d1-43bd-88c6-90f939251252 + + Outputs the protocol endpoint information for selected ProtocolEndpointID. In this case, ProtocolEndpointID: "3ffb55f2-98d1-43bd-88c6-90f939251252". + + + + + + + Get-SFQoSPolicy + + Gets QoS Policy information, either by name or ID. + + + + + Get + SFQoSPolicy + + + + Gets QoS Policy information, either by name or ID. + + + + Get-SFQoSPolicy + + QoSPolicyID + + QoSPolicy ID number + + int + + + + Name + + QoSPolicy Name + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Name + + QoSPolicy Name + + string + + string + + + + + QoSPolicyID + + QoSPolicy ID number + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFQoSPolicy -QoSPolicyID 14 + + Gets QoS Policy information for the policy with ID 14. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFQoSPolicy -Name "US*" + + Gets QoS Policy information for all policies whose name starts with "US". + + + + + + + Get-SFRawStats + + [Cluster] Used by SolidFire engineering to troubleshoot new features. + + + + + Get + SFRawStats + + + + [Cluster] Used by SolidFire engineering to troubleshoot new features. + + + + Get-SFRawStats + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + Hashtable + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFRawStats + + + + + + + + + Get-SFRemoteLoggingHost + + [Cluster] Retrieves the current list of log servers. + + + + + Get + SFRemoteLoggingHost + + + + [Cluster] Retrieves the current list of log servers. + + + + Get-SFRemoteLoggingHost + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + LoggingServer[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoggingServer.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFRemoteLoggingHost + + + + + + + + + Get-SFSchedule + + [Cluster] Gets the scheduled snapshots on a cluster. + + + + + Get + SFSchedule + + + + [Cluster] Gets the scheduled snapshots on a cluster. + + + + Get-SFSchedule + + ScheduleID + + Enter a schedule ID or list of schedule IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + ScheduleID + + Enter a schedule ID or list of schedule IDs. + + long[] + + long[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + Schedule[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSchedule + + Lists all schedules. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSchedule -ScheduleID 5 + + Get single Schedule by ID. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSchedule -ScheduleID 5,6,7,8,9,10 + + Gets list of Schedules by ID. + + + + + + + Get-SFServices + + [Cluster] Lists the services running on the cluster. + + + + + Get + SFServices + + + + You can use ListServices to return the services information for nodes, drives, current software, and other services that are running on the cluster. + + + + Get-SFServices + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + DetailedService[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DetailedService.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFServices + + + + + + + + + Get-SFSnapMirrorAggregates + + [Cluster] Get-SFSnapMirrorAggregates lists all SnapMirror aggregates that are available on the remote ONTAP system. An aggregate describes a set of physical storage resources. + + + + + Get + SFSnapMirrorAggregates + + + + [Cluster] Get-SFSnapMirrorAggregates lists all SnapMirror aggregates that are available on the remote ONTAP system. An aggregate describes a set of physical storage resources. + + + + Get-SFSnapMirrorAggregates + + SnapMirrorEndpointID + + Return only the aggregates associated with the specified endpoint ID. If no endpoint ID is provided, the system lists aggregates from all known SnapMirror endpoints. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + Return only the aggregates associated with the specified endpoint ID. If no endpoint ID is provided, the system lists aggregates from all known SnapMirror endpoints. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorAggregatesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorAggregatesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorAggregates + + Lists the aggregates for all endpoint. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorAggregates -SnapMirrorEndpointID 5 + + Lists the aggregates for the endpoint with ID 5. + + + + + + + Get-SFSnapMirrorClusterIdentity + + [Cluster] Get-SFSnapMirrorClusterIdentity gets identity information about the ONTAP cluster. + + + + + Get + SFSnapMirrorClusterIdentity + + + + [Cluster] Get-SFSnapMirrorClusterIdentity gets identity information about the ONTAP cluster. + + + + Get-SFSnapMirrorClusterIdentity + + SnapMirrorEndpointID + + The endpoint to pull Cluster Identity information from. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint to pull Cluster Identity information from. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSnapMirrorClusterIdentityResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnapMirrorClusterIdentityResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorClusterIdentity + + Gets the cluster identity associated with all endpoints. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorClusterIdentity -SnapMirrorEndpointID 5 + + Gets the cluster identity associated with the endpoint with ID 5. + + + + + + + Get-SFSnapMirrorEndpoints + + [Cluster] Get-SFSnapMirrorEndpoints lists all SnapMirror endpoints that the SolidFire cluster is communicating with. + + + + + Get + SFSnapMirrorEndpoints + + + + [Cluster] Get-SFSnapMirrorEndpoints lists all SnapMirror endpoints that the SolidFire cluster is communicating with. + + + + Get-SFSnapMirrorEndpoints + + SnapMirrorEndpointIDs + + The IDs of endpoints to return. Leave empty to return all endpoints. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointIDs + + The IDs of endpoints to return. Leave empty to return all endpoints. + + long[] + + long[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorEndpointsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorEndpointsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorEndpoints + + Lists all endpoints. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorEndpoints -SnapMirrorEndpointIDs 5,6,7 + + List endpoints with ID 5,6,7. + + + + + + + Get-SFSnapMirrorLuns + + [Cluster] Get-SFSnapMirrorLuns lists the LUN information for the SnapMirror relationship from the remote ONTAP cluster. + + + + + Get + SFSnapMirrorLuns + + + + [Cluster] Get-SFSnapMirrorLuns lists the LUN information for the SnapMirror relationship from the remote ONTAP cluster. + + + + Get-SFSnapMirrorLuns + + SnapMirrorEndpointID + + List only the LUN information associated with the specified endpoint ID. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List only the LUN information associated with the specified endpoint ID. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorLunsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorLunsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorLuns -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeVserver $vserverName -DestinationVolumeName $lunVolumeName + + Gets the SnapMirror LUNs from a specific endpoint. This requires destination volume information to be supplied. If type is "ontap" then you need name, type, and vserver. If type is "solidfire" then you need type and volumeID. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorLuns -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "solidfire" -DestinationVolumeID $volumeID + + Gets the SnapMirror LUNs from a specific endpoint. This requires destination volume information to be supplied. If type is "ontap" then you need name, type, and vserver. If type is "solidfire" then you need type and volumeID, and name is optional. + + + + + + + Get-SFSnapMirrorNetworkInterfaces + + [Cluster] Get-SFSnapMirrorNetworkInterfaces lists all available SnapMirror interfaces on a remote ONTAP system. + + + + + Get + SFSnapMirrorNetworkInterfaces + + + + [Cluster] Get-SFSnapMirrorNetworkInterfaces lists all available SnapMirror interfaces on a remote ONTAP system. + + + + Get-SFSnapMirrorNetworkInterfaces + + InterfaceRole + + List only the network interface serving the specified role. + + string + + + + SnapMirrorEndpointID + + Return Networl Interfaces from a specific endpoint. Leave empty to return from all endpoints. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + InterfaceRole + + List only the network interface serving the specified role. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + Return Networl Interfaces from a specific endpoint. Leave empty to return from all endpoints. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorNetworkInterfacesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorNetworkInterfacesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorNetworkInterfaces + + List all network interfaces. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorNetworkInterfaces -SnapMirrorEndpointID 5 + + List all network interfaces on the endpoint with ID 5. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSnapMirrorNetworkInterfaces -InterfaceRole node_mgmt + + List all network interfaces of type "node_mgmt" on all endpoints. + + + + + + + Get-SFSnapMirrorNodes + + [Cluster] Get-SFSnapMirrorNodes lists the nodes in a remote ONTAP cluster. + + + + + Get + SFSnapMirrorNodes + + + + [Cluster] Get-SFSnapMirrorNodes lists the nodes in a remote ONTAP cluster. + + + + Get-SFSnapMirrorNodes + + SnapMirrorEndpointID + + List nodes from a specific endpoint. Leave empty to return from all. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List nodes from a specific endpoint. Leave empty to return from all. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorNodesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorNodesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorNodes + + Lists nodes for all endpoints. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorNodes -SnapMirrorEndpointID 5 + + Lists node associated with the endpoint with ID 5. + + + + + + + Get-SFSnapMirrorPolicies + + [Cluster] Get-SFSnapMirrorPolicies lists all SnapMirror policies on a remote ONTAP system. + + + + + Get + SFSnapMirrorPolicies + + + + [Cluster] Get-SFSnapMirrorPolicies lists all SnapMirror policies on a remote ONTAP system. + + + + Get-SFSnapMirrorPolicies + + SnapMirrorEndpointID + + List policies from a specific endpoint. Leave empty to return from all. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List policies from a specific endpoint. Leave empty to return from all. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorPoliciesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorPoliciesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorPolicies + + Lists policies for all endpoints. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorPolicies -SnapMirrorEndpointID 5 + + Lists policies for the endpoint with ID 5. + + + + + + + Get-SFSnapMirrorRelationships + + [Cluster] Get-SFSnapMirrorRelationships lists one or all SnapMirror relationships on a SolidFire cluster. + + + + + Get + SFSnapMirrorRelationships + + + + [Cluster] Get-SFSnapMirrorRelationships lists one or all SnapMirror relationships on a SolidFire cluster. + + + + Get-SFSnapMirrorRelationships + + SnapMirrorEndpointID + + List only the relationships associated with the specified endpoint ID. If no endpoint ID is provided, the system lists relationships from all known SnapMirror endpoints. + + long + + + + Vserver + + List relationships on the specified Vserver. + + string + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + SourceVolumeType + + The source volume's type in the SnapMirror relationship. + + string + + + + SourceVolumeName + + The source volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + SourceVolumeVserver + + The source volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + SourceVolumeID + + The source volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List only the relationships associated with the specified endpoint ID. If no endpoint ID is provided, the system lists relationships from all known SnapMirror endpoints. + + long + + long + + + + + SourceVolumeID + + The source volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + SourceVolumeName + + The source volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + SourceVolumeType + + The source volume's type in the SnapMirror relationship. + + string + + string + + + + + SourceVolumeVserver + + The source volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Vserver + + List relationships on the specified Vserver. + + string + + string + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorRelationshipsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorRelationshipsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorRelationships -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID + + Lists off the relationships for a specific endpoint. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorRelationships -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeVserver $vserverName -DestinationVolumeName $lunVolumeName + + Lists off a specific relationship. This requires destination volume information to be supplied. If type is "ontap" then you need name, type, and vserver. If type is "solidfire" then you need type and volumeID. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSnapMirrorRelationships -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "solidfire" -DestinationVolumeID $volumeID -DestinationVolumeName $volumeName + + Lists off a specific relationship. This requires destination volume information to be supplied. If type is "ontap" then you need name, type, and vserver. If type is "solidfire" then you need type and volumeID, and name is optional. + + + + + + + Get-SFSnapMirrorSchedules + + [Cluster] Get-SFSnapMirrorSchedules lists the schedules that are available on a remote ONTAP cluster. + + + + + Get + SFSnapMirrorSchedules + + + + [Cluster] Get-SFSnapMirrorSchedules lists the schedules that are available on a remote ONTAP cluster. + + + + Get-SFSnapMirrorSchedules + + SnapMirrorEndpointID + + List schedules from a specific endpoint. Leave empty to return from all. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List schedules from a specific endpoint. Leave empty to return from all. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorSchedulesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorSchedulesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorSchedules + + Gets the schedules associated with all endpoints. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorSchedules -SnapMirrorEndpointID 5 + + Gets the schedules associated with the endpoint with ID 5. + + + + + + + Get-SFSnapMirrorVolumes + + [Cluster] Get-SFSnapMirrorVolumes lists all SnapMirror volumes available on a remote ONTAP system. + + + + + Get + SFSnapMirrorVolumes + + + + [Cluster] Get-SFSnapMirrorVolumes lists all SnapMirror volumes available on a remote ONTAP system. + + + + Get-SFSnapMirrorVolumes + + SnapMirrorEndpointID + + List volumes from a specific endpoint. Leave empty to return from all. + + long + + + + Vserver + + List volumes hosted on the specified Vserver. The Vserver must be of type "data". + + string + + + + Name + + List only ONTAP volumes with the specified name. + + string + + + + Type + + List only ONTAP volumes of the specified type. Possible values: rw: Read-write volumes, ls: Load-sharing volumes, dp: Data protection volumes. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Name + + List only ONTAP volumes with the specified name. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List volumes from a specific endpoint. Leave empty to return from all. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Type + + List only ONTAP volumes of the specified type. Possible values: rw: Read-write volumes, ls: Load-sharing volumes, dp: Data protection volumes. + + string + + string + + + + + Vserver + + List volumes hosted on the specified Vserver. The Vserver must be of type "data". + + string + + string + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorVolumesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorVolumesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorVolumes -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID + + Gets all SnapMirror volumes from a specific endpoint. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorVolumes -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -Type "dp" + + Gets all SnapMirror data protection volumes from a specific endpoint. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorVolumes -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -Vserver "myVserver" + + Gets all SnapMirror volumes from a specific endpoint that are part of the selected vserver. + + + + + + + Get-SFSnapMirrorVservers + + [Cluster] Get-SFSnapMirrorVservers lists all SnapMirror Vservers available on a remote ONTAP system. + + + + + Get + SFSnapMirrorVservers + + + + [Cluster] Get-SFSnapMirrorVservers lists all SnapMirror Vservers available on a remote ONTAP system. + + + + Get-SFSnapMirrorVservers + + SnapMirrorEndpointID + + List Vservers from a specific endpoint. Leave empty to return from all. + + long + + + + VserverType + + List only Vservers of the specified type. + + string + + + + VserverName + + List only Vservers with the specified name. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + List Vservers from a specific endpoint. Leave empty to return from all. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VserverName + + List only Vservers with the specified name. + + string + + string + + + + + VserverType + + List only Vservers of the specified type. + + string + + string + + + + + + + + None + + + + + + + + + + + + + ListSnapMirrorVserversResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListSnapMirrorVserversResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorVservers + + Lists all the vservers. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorVservers -SnapMirrorEndpointID 5 -VserverType admin + + Lists all vservers of type "admin" on the endpoint with ID 5. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSnapMirrorVservers -VserverName Cluster + + Lists all vservers with the name "Cluster". + + + + + + + Get-SFSnapshot + + [Cluster] Gets the attributes of each snapshot taken on a volume. + + + + + Get + SFSnapshot + + + + [Cluster] Gets the attributes of each snapshot taken on a volume. + + + + Get-SFSnapshot + + SnapshotID + + Enter a snapshot ID or list of snapshot IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFSnapshot + + SnapshotName + + Enter a snapshot name or list of snapshot names. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFSnapshot + + VolumeID + + Enter a volume ID or list of volume IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFSnapshot + + Volume + + Specify volume object(s) + + Volume[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + Enter a snapshot ID or list of snapshot IDs. + + long[] + + long[] + + + + + SnapshotName + + Enter a snapshot name or list of snapshot names. + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Volume + + Specify volume object(s) + + Volume[] + + Volume[] + + + + + VolumeID + + Enter a volume ID or list of volume IDs. + + long[] + + long[] + + + + + + + + System.Int64[] +System.String[] +SolidFire.Element.Api.Volume[] + + + + + + + + + + + + + Snapshot[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapshot + + Gets all snapshots for all volumes on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapshot -SnapshotID 36 + + Gets the attributes from snapshot ID 36. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSnapshot -SnapshotName "VMware*" + + Gets all snapshots that include "VMware" at the beginning of the snapshot name. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VM*" | Get-SFSnapshot + + Gets all snapshots from any volumes that inlcude "VM" at the beginning of the volume name. + + + + + + + Get-SFSnmpAcl + + [Cluster] Gets the current SNMP access permissions on cluster nodes. + + + + + Get + SFSnmpAcl + + + + [Cluster] Gets the current SNMP access permissions on cluster nodes. + + + + Get-SFSnmpAcl + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSnmpACLResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnmpAcl + + + + + + + + + Get-SFSnmpInfo + + [Cluster] Gets the current SNMP configuration information. + + + + + Get + SFSnmpInfo + + + + [Cluster] Gets the current SNMP configuration information. + + + + Get-SFSnmpInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSnmpInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnmpInfo + + + + + + + + + Get-SFSnmpState + + [Cluster] Gets the current state of the SNMP feature. + + + + + Get + SFSnmpState + + + + [Cluster] Gets the current state of the SNMP feature. + + + + Get-SFSnmpState + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSnmpStateResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnmpState + + + + + + + + + Get-SFSnmpTrapInfo + + [Cluster] Gets current SNMP trap configuration information. + + + + + Get + SFSnmpTrapInfo + + + + [Cluster] Gets current SNMP trap configuration information. + + + + Get-SFSnmpTrapInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + SFSnmpTrapInfo + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnmpTrapInfo + + + + + + + + + Get-SFSoftwareEncryptionAtRestInfo + + [Cluster] Get details of the current Software Encryption At Rest configuration. + + + + + Get + SFSoftwareEncryptionAtRestInfo + + + + [Cluster] Get details of the current Software Encryption At Rest configuration. + + + + Get-SFSoftwareEncryptionAtRestInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSoftwareEncryptionAtRestInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetEncryptionAtRestInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSoftwareEncryptionAtRestInfo + + Get details of the current Software Encryption At Rest configuration. + + + + + + + Get-SFSshInfo + + [Node] Returns SSH status for the node. + + + + + Get + SFSshInfo + + + + [Node] Returns SSH status for the node. + + + + Get-SFSshInfo + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSshInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSshInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSshInfo + + Gets SSH info from the currently connected node. + + + + + + + Get-SFSSLCertificate + + [Cluster] Gets the cluster's SSL certificate. + + + + + Get + SFSSLCertificate + + + + [Cluster] Gets the cluster's SSL certificate. + + + + Get-SFSSLCertificate + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSSLCertificate + + Gets the cluster's SSL certificate. + + + + + + + Get-SFStorageContainer + + Gets information for all storage containers currently in the system. + + + + + Get + SFStorageContainer + + + + Gets information for all storage containers currently in the system. + + + + Get-SFStorageContainer + + StorageContainerID + + List of storage containers to get + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StorageContainerID + + List of storage containers to get + + guid[] + + guid[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Guid[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFStorageContainer + + Gets information an all storage contains. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $sContainer = Get-SFStorageContainer -$sContainer[4] - - Stores data and outputs 5th item in list. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFStorageContainer -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff - - Gets information for specific storage container by ID. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff". - - - - - - - Get-SFStorageContainerEfficiency - - Gets efficiency information about a virtual volume storage container. - - - - - Get - SFStorageContainerEfficiency - - - - Gets efficiency information about a virtual volume storage container. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - StorageContainerID - - The ID of the storage container for which to retrieve efficiency information. - - guid - - guid - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Guid - - - - - Gets efficiency information about a virtual volume storage container. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +$sContainer[4] + + Stores data and outputs 5th item in list. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFStorageContainer -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff + + Gets information for specific storage container by ID. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff". + + + + + + + Get-SFStorageContainerEfficiency + + Gets efficiency information about a virtual volume storage container. + + + + + Get + SFStorageContainerEfficiency + + + + Gets efficiency information about a virtual volume storage container. + + + + Get-SFStorageContainerEfficiency + + StorageContainerID + + The ID of the storage container for which to retrieve efficiency information. + + guid + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StorageContainerID + + The ID of the storage container for which to retrieve efficiency information. + + guid + + guid + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Guid + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $sc = Get-SFStorageContainer -Get-SFStorageContainerEfficiency -StorageContainerID $sc[3].StorageContainerID - - Gets the efficiency info from the 4th storage container. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFStorageContainerEfficiency -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff - - Gets the efficiency info from the specified storage container by ID. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff" - - - - - - - Get-SFSyncJob - - [Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster. - - - - - Get - SFSyncJob - - - - [Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster. - - - - - - - - - - SyncJob - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SyncJob.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSyncJob - - - - - - - - - Get-SFSystemStatus - - [Cluster] Gets status of nodes in a SolidFire cluster. - - - - - Get - SFSystemStatus - - - - [Cluster] Gets status of nodes in a SolidFire cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets status of nodes in a SolidFire cluster. - - - - - - - - - - GetSystemStatusResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSystemStatusResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFSystemStatus - - - - - - - - - Get-SFTests - - [Node] Gets the tests that are available to run on a node. - - - - - Get - SFTests - - - - [Node] Gets the tests that are available to run on a node. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Gets the tests that are available to run on a node. - - - - - - - - - - ListTestsResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListTestsResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFTests - - - - - - - - - Get-SFUtilities - - [Node] Gets the utilities that are available to run on a node. - - - - - Get - SFUtilities - - - - [Node] Gets the utilities that are available to run on a node. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Gets the utilities that are available to run on a node. - - - - - - - - - - ListUtilitiesResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListUtilitiesResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFUtilities - - - - - - - - - Get-SFVirtualNetwork - - [Cluster] Gets a list of all the configured virtual networks for the cluster. - - - - - Get - SFVirtualNetwork - - - - [Cluster] Gets a list of all the configured virtual networks for the cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualNetworkID - - Enter a VirtualNetworkID or list of VirtualNetworkIDs. - - long[] - - long[] - - - - - - VirtualNetworkTag - - Enter a VirtualNetworkTag or list of VirtualNetworkTag. - - long[] - - long[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets a list of all the configured virtual networks for the cluster. - - - - - - - - - - VirtualNetwork[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVirtualNetwork - - Gets all virtual networks configured on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVirtualNetwork -VirtualNetworkID 12 - - Gets the specified virtual network(s). - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVirtualNetwork -VirtualNetworkTag 120 - - Gets the virtual network corresponding to the specified VLAN tag. - - - - - - - Get-SFVirtualVolume - - Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset. - - - - - Get - SFVirtualVolume - - - - Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset. - - - - Details - - Possible values: true: Include more details about each VVOL in the response. false: Include the standard level of detail about each VVOL in the response. - - bool - - bool - - - - - - Limit - - The maximum number of virtual volumes to list. - - long - - long - - - - - - Recursive - - Possible values:true: Include information about the children of each VVOL in the response. false: Do not include information about the children of each VVOL in the response. - - bool - - bool - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - StartVirtualVolumeID - - The ID of the virtual volume at which to begin the list. - - guid - - guid - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualVolumeIDs - - A list of virtual volume IDs for which to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes. - - guid[] - - guid[] - - - - - - - - - None - - - - - Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVirtualVolume - - Lists all VVols in the system with default output. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVirtualVolume -Details:$true -Limit 2 - - Lists VVols with additional details but limits list to the first 2 VVols. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - +Get-SFStorageContainerEfficiency -StorageContainerID $sc[3].StorageContainerID + + Gets the efficiency info from the 4th storage container. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFStorageContainerEfficiency -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff + + Gets the efficiency info from the specified storage container by ID. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff" + + + + + + + Get-SFSupportedTlsCiphers + + [Cluster] Get-SFSupportedTlsCiphers gets a list of the supported TLS ciphers. + + + + + Get + SFSupportedTlsCiphers + + + + [Cluster] Get-SFSupportedTlsCiphers gets a list of the supported TLS ciphers. + + + + Get-SFSupportedTlsCiphers + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSupportedTlsCiphersResult + + + + + + + + + Get-SFSyncJob + + [Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster. + + + + + Get + SFSyncJob + + + + [Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster. + + + + Get-SFSyncJob + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + SyncJob + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SyncJob.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSyncJob + + + + + + + + + Get-SFSystemStatus + + [Cluster] Gets status of nodes in a SolidFire cluster. + + + + + Get + SFSystemStatus + + + + [Cluster] Gets status of nodes in a SolidFire cluster. + + + + Get-SFSystemStatus + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + GetSystemStatusResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSystemStatusResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSystemStatus + + + + + + + + + Get-SFTests + + [Node] Gets the tests that are available to run on a node. + + + + + Get + SFTests + + + + [Node] Gets the tests that are available to run on a node. + + + + Get-SFTests + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListTestsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListTestsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFTests + + + + + + + + + Get-SFUtilities + + [Node] Gets the utilities that are available to run on a node. + + + + + Get + SFUtilities + + + + [Node] Gets the utilities that are available to run on a node. + + + + Get-SFUtilities + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ListUtilitiesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListUtilitiesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFUtilities + + + + + + + + + Get-SFVirtualNetwork + + [Cluster] Gets a list of all the configured virtual networks for the cluster. + + + + + Get + SFVirtualNetwork + + + + [Cluster] Gets a list of all the configured virtual networks for the cluster. + + + + Get-SFVirtualNetwork + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVirtualNetwork + + VirtualNetworkID + + + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVirtualNetwork + + VirtualNetworkTag + + Enter a VirtualNetworkTag or list of VirtualNetworkTag. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualNetworkID + + Enter a VirtualNetworkID or list of VirtualNetworkIDs. + + long[] + + long[] + + + + + VirtualNetworkTag + + Enter a VirtualNetworkTag or list of VirtualNetworkTag. + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + VirtualNetwork[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVirtualNetwork + + Gets all virtual networks configured on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVirtualNetwork -VirtualNetworkID 12 + + Gets the specified virtual network(s). + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVirtualNetwork -VirtualNetworkTag 120 + + Gets the virtual network corresponding to the specified VLAN tag. + + + + + + + Get-SFVirtualVolume + + Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset. + + + + + Get + SFVirtualVolume + + + + Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset. + + + + Get-SFVirtualVolume + + Details + + Possible values: true: Include more details about each VVOL in the response. false: Include the standard level of detail about each VVOL in the response. + + bool + + + + Limit + + The maximum number of virtual volumes to list. + + long + + + + Recursive + + Possible values:true: Include information about the children of each VVOL in the response. false: Do not include information about the children of each VVOL in the response. + + bool + + + + StartVirtualVolumeID + + The ID of the virtual volume at which to begin the list. + + guid + + + + VirtualVolumeIDs + + A list of virtual volume IDs for which to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes. + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Details + + Possible values: true: Include more details about each VVOL in the response. false: Include the standard level of detail about each VVOL in the response. + + bool + + bool + + + + + Limit + + The maximum number of virtual volumes to list. + + long + + long + + + + + Recursive + + Possible values:true: Include information about the children of each VVOL in the response. false: Do not include information about the children of each VVOL in the response. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StartVirtualVolumeID + + The ID of the virtual volume at which to begin the list. + + guid + + guid + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualVolumeIDs + + A list of virtual volume IDs for which to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes. + + guid[] + + guid[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVirtualVolume + + Lists all VVols in the system with default output. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVirtualVolume -Details:$true -Limit 2 + + Lists VVols with additional details but limits list to the first 2 VVols. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + $vvols = Get-SFVirtualVolume -Get-SFVirtualVolume -StartVirtualVolumeID $vvols[4].VirtualVolumeID - - Gets the VVols information and then lists it out starting at the 5th entry. - - - - - - - Get-SFVirtualVolumeBinding - - Gets a list of VVol bindings. - - - - - Get - SFVirtualVolumeBinding - - - - Gets a list of VVol bindings. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualVolumeBindingIDs - - - - long[] - - long[] - - - - - - - - - None - - - - - Gets a list of VVol bindings. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVirtualVolumeBinding - - Lists all VVol bindings. If none, returns empty object. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVirtualVolumeBinding -VirtualVolumeBindingIDs 14,15,16 - - Returns VVol binding by ID. - - - - - - - Get-SFVirtualVolumeCount - - Gets the number of virtual volumes currently in the system. - - - - - Get - SFVirtualVolumeCount - - - - Gets the number of virtual volumes currently in the system. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Gets the number of virtual volumes currently in the system. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVirtualVolumeCount - - - - - - - - - Get-SFVirtualVolumeHost - - Gets a list of known ESX hosts. - - - - - Get - SFVirtualVolumeHost - - - - Gets a list of known ESX hosts. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualVolumeHostIDs - - - - guid[] - - guid[] - - - - - - - - - None - - - - - Gets a list of known ESX hosts. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVirtualVolumeHost - - Gets all knowns ESX hosts. - - - - - - - Get-SFVirtualVolumeTask - - Gets a list of VVol Async Tasks. - - - - - Get - SFVirtualVolumeTask - - - - Gets a list of VVol Async Tasks. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualVolumeTaskIDs - - - - guid[] - - guid[] - - - - - - - - - None - - - - - Gets a list of VVol Async Tasks. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVirtualVolumeTask - - Gets a list of VVols Async Tasks. - - - - - - - Get-SFVolume - - [Cluster] Gets a list of volumes from the cluster. - - - - - Get - SFVolume - - - - [Cluster] Gets a list of volumes from the cluster. - - - - Account - - Specify account(s). - - Account[] - - Account[] - - - - - - AccountID - - Enter an Account ID or list of Account IDs. - - long[] - - long[] - - - - - - ExcludeVVOLs - - Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. - - - switch - - - - - - IncludeDeleted - - Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes. - - - switch - - - - - - Name - - Enter a volume name or list of volume names. - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Enter a VolumeID or list of VolumeIDs. - - long[] - - long[] - - - - - - - - - System.Int64[] -System.String[] -SolidFire.Element.Api.Account[] - - - - - [Cluster] Gets a list of volumes from the cluster. - - - - - - - - - - Volume[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolume - - Gets all active volumes on the system. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolume -Name "VM*" -IncludeDeleted - - Gets all volumes, both active and deleted, with names that begin with "VM". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolume -VolumeID 3 - - Return only the volume with ID 3. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - - Get-SFVolume -AccountID 13 - - Gets all volumes associated with account ID 13. - - - - -------------------------- EXAMPLE 5 -------------------------- - - PS C:\> - - Get-SFAccount -Username "Customer*" | Get-SFVolume - - Gets all volumes associated with all accounts that have names beginning with "Customer". - - - - - - - Get-SFVolumeAccessGroup - - [Cluster] Gets information about a SolidFire volume access group. - - - - - Get - SFVolumeAccessGroup - - - - [Cluster] Gets information about a SolidFire volume access group. - - - - Name - - Enter a volume name or list of volume names. - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID or list of volume access group IDs. - - long[] - - long[] - - - - - - - - - System.Int64[] -System.String[] - - - - - [Cluster] Gets information about a SolidFire volume access group. - - - - - - - - - - VolumeAccessGroup[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroup - - Gets all volume access groups on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroup -Name "VM*" - - Gets all volume access groups with a name beginning with "VM". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroup -VolumeAccessGroupID 2,3 - - Gets the specified volume access group(s). - - - - - - - Get-SFVolumeAccessGroupEfficiency - - [Cluster] Gets efficiency information about all volumes in a volume access group. - - - - - Get - SFVolumeAccessGroupEfficiency - - - - [Cluster] Gets efficiency information about all volumes in a volume access group. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroup - - Enter a volume access group - - VolumeAccessGroup[] - - VolumeAccessGroup[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID - - long[] - - long[] - - - - - - - - - System.Int64[] -SolidFire.Element.Api.VolumeAccessGroup[] - - - - - [Cluster] Gets efficiency information about all volumes in a volume access group. - - - - - - - - - - GetVolumeEfficiencyResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetVolumeEfficiencyResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroupEfficiency -VolumeAccessGroupID 13 - - Gets efficiency information for the volume access group with ID 13. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroup -VolumeAccessGroupName "VMware*" | Get-SFVolumeAccessGroupEfficiency - - Gets the efficiency for any volume access group where the name begins with "VMware". - - - - - - - Get-SFVolumeEfficiency - - [Cluster] Gets efficiency information about a volume. - - - - - Get - SFVolumeEfficiency - - - - [Cluster] Gets efficiency information about a volume. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Enter a volume ID or list of volume IDs - - long - - long - - - - - - - - - System.Int64 - - - - - [Cluster] Gets efficiency information about a volume. - - - - - - - - - - GetVolumeEfficiencyResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetVolumeEfficiencyResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolumeEfficiency -VolumeID 19 - - Gets the values for the most recent automatic calculation of efficiency numbers for volume ID 19. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolumeEfficiency -VolumeID 19 -ForceGet - - The -ForceGet parameter forces the cluster to recalculate the efficiency numbers for that volume immediately rather than returning the stored values from the most recent automatic run. - - - - - - - Get-SFVolumePair - - [Cluster] Gets a list of all of the active paired volumes paired with a volume. - - - - - Get - SFVolumePair - - - - [Cluster] Gets a list of all of the active paired volumes paired with a volume. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Gets a list of all of the active paired volumes paired with a volume. - - - - - - - - - - Volume[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolumePair - - - - - - - - - Get-SFVolumeStats - - [Cluster] Gets high-level activity measurements for the specified volume(s). - - - - - Get - SFVolumeStats - - - - [Cluster] Gets high-level activity measurements for the specified volume(s). - - - - AccountID - - Enter an AccountID or list of AccountIDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID or list of volume access group IDs - - long[] - - long[] - - - - - - VolumeID - - Enter a volume ID or list of volume IDs - - long[] - - long[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Gets high-level activity measurements for the specified volume(s). - - - - - - - - - - VolumeStats[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeStats.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolumeStats - - Gets volume stats for all volumes on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolumeStats -VolumeID 13,15 - - Gets volume stats for the specified volume(s). - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolumeStats -AccountID 13 - - Gets volume stats for all volumes associated with account ID 13. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - - Get-SFVolumeStats -VolumeAccessGroupID 15 - - Gets stats for all volumes included in volume access group ID 15. - - - - -------------------------- EXAMPLE 5 -------------------------- - - PS C:\> - - Get-SFVolume -Name "*VMware*" | Get-SFVolumeStats - - Gets volume stats for all volumes that have "VMware" in the volume name. - - - - - - - Get-SFVolumeStatsByVirtualVolume - - Gets a list of virtual volume statistics for any virtual volume in system. - - - - - Get - SFVolumeStatsByVirtualVolume - - - - Gets a list of virtual volume statistics for any virtual volume in system. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualVolumeID - - A list of virtual volume IDs used to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes. - - guid[] - - guid[] - - - - - - - - - System.Guid[] - - - - - Gets a list of virtual volume statistics for any virtual volume in system. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Get-SFVolumeStatsByVirtualVolume - - Gets a list of VVol stats for all VVols in the system. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Get-SFVirtualVolume -StartVirtualVolumeID $vvols[4].VirtualVolumeID + + Gets the VVols information and then lists it out starting at the 5th entry. + + + + + + + Get-SFVirtualVolumeBinding + + Gets a list of VVol bindings. + + + + + Get + SFVirtualVolumeBinding + + + + Gets a list of VVol bindings. + + + + Get-SFVirtualVolumeBinding + + VirtualVolumeBindingIDs + + + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualVolumeBindingIDs + + + + long[] + + long[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVirtualVolumeBinding + + Lists all VVol bindings. If none, returns empty object. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVirtualVolumeBinding -VirtualVolumeBindingIDs 14,15,16 + + Returns VVol binding by ID. + + + + + + + Get-SFVirtualVolumeCount + + Gets the number of virtual volumes currently in the system. + + + + + Get + SFVirtualVolumeCount + + + + Gets the number of virtual volumes currently in the system. + + + + Get-SFVirtualVolumeCount + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVirtualVolumeCount + + + + + + + + + Get-SFVirtualVolumeHost + + Gets a list of known ESX hosts. + + + + + Get + SFVirtualVolumeHost + + + + Gets a list of known ESX hosts. + + + + Get-SFVirtualVolumeHost + + VirtualVolumeHostIDs + + + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualVolumeHostIDs + + + + guid[] + + guid[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVirtualVolumeHost + + Gets all knowns ESX hosts. + + + + + + + Get-SFVirtualVolumeTask + + Gets a list of VVol Async Tasks. + + + + + Get + SFVirtualVolumeTask + + + + Gets a list of VVol Async Tasks. + + + + Get-SFVirtualVolumeTask + + VirtualVolumeTaskIDs + + + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualVolumeTaskIDs + + + + guid[] + + guid[] + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVirtualVolumeTask + + Gets a list of VVols Async Tasks. + + + + + + + Get-SFVolume + + [Cluster] Gets a list of volumes from the cluster. + + + + + Get + SFVolume + + + + [Cluster] Gets a list of volumes from the cluster. + + + + Get-SFVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + VolumeID + + Enter a VolumeID or list of VolumeIDs. + + long[] + + + + VolumeStatus + + Only volumes with a status equal to the status value are returned. Possible values are: creating, snapshotting, active, deleted. + + string + + + + Limit + + Specifies the maximum number of volume results that are returned. + + long + + + + IsPaired + + Returns volumes that are paired or not paired. + + bool + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + IncludeDeleted + + Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes. + + + + + ProtectionSchemes + + Only volumes that are using one of the protection schemes in this set are returned. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolume + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + Name + + Enter a volume name or list of volume names. + + string[] + + + + VolumeStatus + + Only volumes with a status equal to the status value are returned. Possible values are: creating, snapshotting, active, deleted. + + string + + + + Limit + + Specifies the maximum number of volume results that are returned. + + long + + + + IsPaired + + Returns volumes that are paired or not paired. + + bool + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + IncludeDeleted + + Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes. + + + + + ProtectionSchemes + + Only volumes that are using one of the protection schemes in this set are returned. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolume + + AccountID + + Enter an Account ID or list of Account IDs. + + long[] + + + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + VolumeStatus + + Only volumes with a status equal to the status value are returned. Possible values are: creating, snapshotting, active, deleted. + + string + + + + Limit + + Specifies the maximum number of volume results that are returned. + + long + + + + IsPaired + + Returns volumes that are paired or not paired. + + bool + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + IncludeDeleted + + Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes. + + + + + ProtectionSchemes + + Only volumes that are using one of the protection schemes in this set are returned. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolume + + Account + + Specify account(s). + + Account[] + + + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + + + VolumeStatus + + Only volumes with a status equal to the status value are returned. Possible values are: creating, snapshotting, active, deleted. + + string + + + + Limit + + Specifies the maximum number of volume results that are returned. + + long + + + + IsPaired + + Returns volumes that are paired or not paired. + + bool + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + + + IncludeDeleted + + Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes. + + + + + ProtectionSchemes + + Only volumes that are using one of the protection schemes in this set are returned. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Account + + Specify account(s). + + Account[] + + Account[] + + + + + AccountID + + Enter an Account ID or list of Account IDs. + + long[] + + long[] + + + + + ExcludeVVOLs + + Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes. + + + switch + + + + + IncludeDeleted + + Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes. + + + switch + + + + + IsPaired + + Returns volumes that are paired or not paired. + + bool + + bool + + + + + Limit + + Specifies the maximum number of volume results that are returned. + + long + + long + + + + + Name + + Enter a volume name or list of volume names. + + string[] + + string[] + + + + + ProtectionSchemes + + Only volumes that are using one of the protection schemes in this set are returned. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StartVolumeID + + Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response +1. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a VolumeID or list of VolumeIDs. + + long[] + + long[] + + + + + VolumeStatus + + Only volumes with a status equal to the status value are returned. Possible values are: creating, snapshotting, active, deleted. + + string + + string + + + + + + + + System.Int64[] +System.String[] +SolidFire.Element.Api.Account[] + + + + + + + + + + + + + Volume + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolume + + Gets all volumes on the system. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VM*" -VolumeStatus deleted + + Gets all deleted volumes, with names that begin with "VM". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolume -VolumeID 3 + + Return only the volume with ID 3. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFVolume -AccountID 13,1 + + Gets all volumes associated with account ID 13 and 1. + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Get-SFAccount -Username "Customer*" | Get-SFVolume + + Gets all volumes associated with all accounts that have names beginning with "Customer". + + + + + + + Get-SFVolumeAccessGroup + + [Cluster] Gets information about a SolidFire volume access group. + + + + + Get + SFVolumeAccessGroup + + + + [Cluster] Gets information about a SolidFire volume access group. + + + + Get-SFVolumeAccessGroup + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolumeAccessGroup + + Name + + Enter a volume name or list of volume names. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Name + + Enter a volume name or list of volume names. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs. + + long[] + + long[] + + + + + + + + System.Int64[] +System.String[] + + + + + + + + + + + + + VolumeAccessGroup[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolumeAccessGroup + + Gets all volume access groups on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolumeAccessGroup -Name "VM*" + + Gets all volume access groups with a name beginning with "VM". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolumeAccessGroup -VolumeAccessGroupID 2,3 + + Gets the specified volume access group(s). + + + + + + + Get-SFVolumeAccessGroupEfficiency + + [Cluster] Gets efficiency information about all volumes in a volume access group. + + + + + Get + SFVolumeAccessGroupEfficiency + + + + [Cluster] Gets efficiency information about all volumes in a volume access group. + + + + Get-SFVolumeAccessGroupEfficiency + + VolumeAccessGroupID + + Enter a volume access group ID + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolumeAccessGroupEfficiency + + VolumeAccessGroup + + Enter a volume access group + + VolumeAccessGroup[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroup + + Enter a volume access group + + VolumeAccessGroup[] + + VolumeAccessGroup[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID + + long[] + + long[] + + + + + + + + System.Int64[] +SolidFire.Element.Api.VolumeAccessGroup[] + + + + + + + + + + + + + GetVolumeEfficiencyResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetVolumeEfficiencyResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolumeAccessGroupEfficiency -VolumeAccessGroupID 13 + + Gets efficiency information for the volume access group with ID 13. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolumeAccessGroup -VolumeAccessGroupName "VMware*" | Get-SFVolumeAccessGroupEfficiency + + Gets the efficiency for any volume access group where the name begins with "VMware". + + + + + + + Get-SFVolumeEfficiency + + [Cluster] Gets efficiency information about a volume. + + + + + Get + SFVolumeEfficiency + + + + [Cluster] Gets efficiency information about a volume. + + + + Get-SFVolumeEfficiency + + VolumeID + + Enter a volume ID or list of volume IDs + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a volume ID or list of volume IDs + + long + + long + + + + + + + + System.Int64 + + + + + + + + + + + + + GetVolumeEfficiencyResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetVolumeEfficiencyResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolumeEfficiency -VolumeID 19 + + Gets the values for the most recent automatic calculation of efficiency numbers for volume ID 19. + + + + + + + Get-SFVolumePair + + [Cluster] Gets a list of all of the active paired volumes paired with a volume. To restrict the output to a single volume, specify either the SourceVolumeID or SourceVolumeName, but not both. + + + + + Get + SFVolumePair + + + + [Cluster] Gets a list of all of the active paired volumes paired with a volume. + + + + Get-SFVolumePair + + SourceVolumeID + + Source Volume ID with which to filter results + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolumePair + + SourceVolumeName + + Source Volume name with which to filter results + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SourceVolumeID + + Source Volume ID with which to filter results + + long + + long + + + + + SourceVolumeName + + Source Volume name with which to filter results + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + Volume[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolumePair + + Gets a list of all active paired volumes. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolumePair -SourceVolumeID 42 + + Gets the active paired volume with volume ID 42. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolumePair -SourceVolumeName db3 + + Gets the active paired volume with volume name "db3". + + + + + + + Get-SFVolumeStats + + [Cluster] Gets high-level activity measurements for the specified volume(s). + + + + + Get + SFVolumeStats + + + + [Cluster] Gets high-level activity measurements for the specified volume(s). + + + + Get-SFVolumeStats + + VolumeID + + Enter a volume ID or list of volume IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolumeStats + + AccountID + + Enter an AccountID or list of AccountIDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Get-SFVolumeStats + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AccountID + + Enter an AccountID or list of AccountIDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs + + long[] + + long[] + + + + + VolumeID + + Enter a volume ID or list of volume IDs + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + VolumeStats[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeStats.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolumeStats + + Gets volume stats for all volumes on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolumeStats -VolumeID 13,15 + + Gets volume stats for the specified volume(s). + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolumeStats -AccountID 13 + + Gets volume stats for all volumes associated with account ID 13. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFVolumeStats -VolumeAccessGroupID 15 + + Gets stats for all volumes included in volume access group ID 15. + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Get-SFVolume -Name "*VMware*" | Get-SFVolumeStats + + Gets volume stats for all volumes that have "VMware" in the volume name. + + + + + + + Get-SFVolumeStatsByVirtualVolume + + Gets a list of virtual volume statistics for any virtual volume in system. + + + + + Get + SFVolumeStatsByVirtualVolume + + + + Gets a list of virtual volume statistics for any virtual volume in system. + + + + Get-SFVolumeStatsByVirtualVolume + + VirtualVolumeID + + A list of virtual volume IDs used to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes. + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualVolumeID + + A list of virtual volume IDs used to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes. + + guid[] + + guid[] + + + + + + + + System.Guid[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFVolumeStatsByVirtualVolume + + Gets a list of VVol stats for all VVols in the system. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $vvols = Get-SFVolumeStatsByVirtualVolume -Get-SFVolumeStatsByVirtualVolume -VirtualVolumeID $vvols[3].VirtualVolumeID - - Gets stats for a VVol specified by VirtualVolumeID. VirtualVolumeIDs look like: "ad0b08a1-7818-4dd5-9b95-ba376b634780". - - - - - - - Invoke-SFApi - - [Node/Cluster] A generic cmdlet that invokes any SolidFire API method. - - - - - Invoke - SFApi - - - - [Node/Cluster] A generic cmdlet that invokes any SolidFire API method. - - - - ForcePort - - - - int - - int - - - - - - Method - - Enter the API Method to call. - - string - - string - - - - - - Params - - Enter any parameters to be passed into this API Method in the form of a Hashtable. - - hashtable - - hashtable - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.String -System.Collections.Hashtable - - - - - [Node/Cluster] A generic cmdlet that invokes any SolidFire API method. - - - - - - - The deserialized JSON returned from the API in the form of a Hashtable - - - Hashtable - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Invoke-SFApi -Method "GetClusterCapacity" - - Runs the GetClusterCapacity method against the API and returns a Hashtable of the response. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Invoke-SFApi -Method "AddAccount" -Params @{ "username" = "TestAccount"; "initiatorSecret" = "123abc123abc"; "targetSecret" = "789xyz789xyz"} - - Creates a new account by directly calling the "AddAccount" API method. Note that the parameters are built as an in-line hashtable. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - +Get-SFVolumeStatsByVirtualVolume -VirtualVolumeID $vvols[3].VirtualVolumeID + + Gets stats for a VVol specified by VirtualVolumeID. VirtualVolumeIDs look like: "ad0b08a1-7818-4dd5-9b95-ba376b634780". + + + + + + + Initialize-SFSnapMirrorRelationship + + [Cluster] Initialize-SFSnapMirrorRelationship initializes the destination volume in a SnapMirror relationship by performing an initial baseline transfer between clusters. + + + + + Initialize + SFSnapMirrorRelationship + + + + [Cluster] Initialize-SFSnapMirrorRelationship initializes the destination volume in a SnapMirror relationship by performing an initial baseline transfer between clusters. + + + + Initialize-SFSnapMirrorRelationship + + SnapMirrorEndpointID + + The ID of the remote ONTAP system. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The ID of the remote ONTAP system. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + InitializeSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_InitializeSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Initialize-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Starts a initial relationship transfer between the volumes in the relaitonship. This runs asyncronously and the status can be checked with Get-SFSnapMirrorRelationships + + + + + + + Invoke-SFApi + + [Node/Cluster] A generic cmdlet that invokes any SolidFire API method. + + + + + Invoke + SFApi + + + + [Node/Cluster] A generic cmdlet that invokes any SolidFire API method. + + + + Invoke-SFApi + + Method + + Enter the API Method to call. + + string + + + + Params + + Enter any parameters to be passed into this API Method in the form of a Hashtable. + + hashtable + + + + ForcePort + + Use this to force the connection to use a different port than it was established with and pass in the desired port number. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ForcePort + + Use this to force the connection to use a different port than it was established with and pass in the desired port number. + + int + + int + + + + + Method + + Enter the API Method to call. + + string + + string + + + + + Params + + Enter any parameters to be passed into this API Method in the form of a Hashtable. + + hashtable + + hashtable + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.String +System.Collections.Hashtable + + + + + + + + + + The deserialized JSON returned from the API in the form of a Hashtable + + + Hashtable + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFApi -Method "GetClusterCapacity" + + Runs the GetClusterCapacity method against the API and returns a Hashtable of the response. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Invoke-SFApi -Method "AddAccount" -Params @{ "username" = "TestAccount"; "initiatorSecret" = "123abc123abc"; "targetSecret" = "789xyz789xyz"} + + Creates a new account by directly calling the "AddAccount" API method. Note that the parameters are built as an in-line hashtable. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + $acct = @{} $acct.Add("username","TestAcct2") $acct.Add("initiatorSecret","123451234512345") $acct.Add("targetSecret","abcdeabcdeabcde") -Invoke-SFApi -Method "AddAccount" -Params $acct - - Builds the parameter hash table one element at a time and then calls Invoke-SFApi leveraging the variable contents. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - +Invoke-SFApi -Method "AddAccount" -Params $acct + + Builds the parameter hash table one element at a time and then calls Invoke-SFApi leveraging the variable contents. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + Array Example: @("First", "Second", "Third") Hashtable/Object Example: @{"First" = "1st"; "Second" = "2nd"; "Third" = "3rd"} -Nested Hashtable Example: @{"NestedObject" = @{"One" = 1; "Two" = 2}; "Status" = "Active"} - - Sometimes the "Params" parameter needs json objects or an array. In order to pass nested json objects and json arrays, use the "@" sign to prepend each item. Objects should be wrapped with curly brackets "{}" and arrays should be wrapped with parentheses "()". Items in an array should be separated with a comma and items in a hashtable/object should be separated with a semicolon. - - - - - - - Invoke-SFRestoreDeletedVolume - - [Cluster] Marks a deleted volume as active again. - - - - - Invoke - SFRestoreDeletedVolume - - - - [Cluster] Marks a deleted volume as active again. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Enter a VolumeID for the deleted volume to restore. - - long - - long - - - - - - - - - System.Int64 - - - - - [Cluster] Marks a deleted volume as active again. - - - - - - - - - - Volume - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Invoke-SFRestoreDeletedVolume -VolumeID 548 - - Restore volume ID 548 from a deleted state back to an active state. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFDeletedVolume | Invoke-SFRestoreDeletedVolume - - Restore all volumes that are currently deleted. - - - - - - - Invoke-SFRollbackToGroupSnapshot - - [Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot. - - - - - Invoke - SFRollbackToGroupSnapshot - - - - [Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot. - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - GroupSnapshotID - - Enter a GroupSnapshotID for the volume to restore. - - long - - long - - - - - - Name - - Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SaveCurrentState - - true: The previous active volume image is kept. false: (default) The previous active volume image is deleted. - - bool - - bool - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String -System.Boolean - - - - - [Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot. - - - - - - - - - - CreateGroupSnapshotResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateGroupSnapshotResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Invoke-SFRollbackToGroupSnapshot -GroupSnapshotID 30 - - Rolls the group of volumes back to the specified group snapshot but does not preserve the current state. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Invoke-SFRollbackToGroupSnapshot -GroupSnapshotID 30 -SaveCurrentState:$true -Name CurrentStateGroupSnapshot - - Rolls the group of volumes back to the specified group snapshot. In this case, the command first takes a new group snapshot of the current volumes' state named "CurrentStateGroupSnapshot" prior to rolling back to the snapshot. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolume -Name RCLPSMTestVol-02 | Get-SFGroupSnapshot -GroupSnapshotName Tuesday | Invoke-SFRollbackToGroupSnapshot -SaveCurrentState:$true -Name CurrentStateGroupSnapsnot - - Finds the group snapshot named "Tuesday" where the volume "RCLPSMTestVol-02" is a member. Then rolls back to this snapshot while saving the current state as a new group snapshot "CurrentStateGroupSnapshot" - - - - - - - Invoke-SFRollbackToSnapshot - - [Cluster] Makes an existing snapshot the "active" volume image. - - - - - Invoke - SFRollbackToSnapshot - - - - [Cluster] Makes an existing snapshot the "active" volume image. - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - Name - - Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SaveCurrentState - - true: The previous active volume image is kept. false: (default) The previous active volume image is deleted. - - bool - - bool - - - - - - SnapshotID - - Enter the SnapshotID of a previously created snapshot on the given volume. - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Enter a VolumeID for the volume to restore. - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String -System.Boolean - - - - - [Cluster] Makes an existing snapshot the "active" volume image. - - - - - - - - - - CreateSnapshotResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapshotResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Invoke-SFRollbackToSnapshot -VolumeID 477 -SnapshotID 2506 - - Rolls the volume back to the specified snapshot but does not preserve the current state. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Invoke-SFRollbackToSnapshot -VolumeID 477 -SnapshotID 2506 -SaveCurrentState:$true -Name CurrentStateSnapshot - - Rolls the volume back to the specified snapshot. In this case, the command first takes a new snapshot of the current state named "CurrentStateSnapshot" prior to rolling back to the snapshot. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolume -Name SampleVol01 | Get-SFSnapshot -SnapshotName Tuesday | Invoke-SFRollbackToSnapshot -SaveCurrentState:$true -Name CurrentStateSnapshot - - Rolls back the volume named "SampleVol01" to the snapshot named "Tuesday" and saves the current state to a new snapshot named "CurrentStateSnapshot". - - - - - - - Invoke-SFSecureEraseDrive - - [Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive. - - - - - Invoke - SFSecureEraseDrive - - - - [Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive. - - - - Confirm - - - - - switch - - - - - - Drive - - Please pass in a SFDrive or list of SFDrives - - DriveInfo[] - - DriveInfo[] - - - - - - DriveID - - Enter a drive ID or list of drive IDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -SolidFire.Element.Api.DriveInfo[] - - - - - [Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive. - - - - - - - - - - AsyncHandleResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AsyncHandleResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Invoke-SFSecureEraseDrive -DriveID 19 - +Nested Hashtable Example: @{"NestedObject" = @{"One" = 1; "Two" = 2}; "Status" = "Active"} + + Sometimes the "Params" parameter needs json objects or an array. In order to pass nested json objects and json arrays, use the "@" sign to prepend each item. Objects should be wrapped with curly brackets "{}" and arrays should be wrapped with parentheses "()". Items in an array should be separated with a comma and items in a hashtable/object should be separated with a semicolon. + + + + + + + Invoke-SFBreakSnapMirrorRelationship + + [Cluster] Invoke-SFBreakSnapMirrorRelationship breaks a SnapMirror relationship. When a SnapMirror relationship is broken, the destination volume is made read-write and independent, and can then diverge from the source. You can reestablish the relationship with the Start-SFResyncSnapMirrorRelationship. This method requires the ONTAP cluster to be available. + + + + + Invoke + SFBreakSnapMirrorRelationship + + + + [Cluster] Invoke-SFBreakSnapMirrorRelationship breaks a SnapMirror relationship. When a SnapMirror relationship is broken, the destination volume is made read-write and independent, and can then diverge from the source. You can reestablish the relationship with the Start-SFResyncSnapMirrorRelationship commandlet. This method requires the ONTAP cluster to be available. + + + + Invoke-SFBreakSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + BreakSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_BreakSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFBreakSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Breaks the relationship between the ontap and solidfire volumes. This command can only be run on relationships that have been successfully initialized. + + + + + + + Invoke-SFBreakSnapMirrorVolume + + [Cluster] Invoke-SFBreakSnapMirrorVolume breaks the SnapMirror relationship between an ONTAP source container and SolidFire target volume. Breaking a SolidFire SnapMirror volume is useful if an ONTAP system becomes unavailable while replicating data to a SolidFire volume. This feature enables a storage administrator to take control of a SolidFire SnapMirror volume, break its relationship with the remote ONTAP system, and revert the volume to a previous snapshot. + + + + + Invoke + SFBreakSnapMirrorVolume + + + + [Cluster] Invoke-SFBreakSnapMirrorVolume breaks the SnapMirror relationship between an ONTAP source container and SolidFire target volume. Breaking a SolidFire SnapMirror volume is useful if an ONTAP system becomes unavailable while replicating data to a SolidFire volume. This feature enables a storage administrator to take control of a SolidFire SnapMirror volume, break its relationship with the remote ONTAP system, and revert the volume to a previous snapshot. + + + + Invoke-SFBreakSnapMirrorVolume + + VolumeID + + The volume on which to perform the break operation. The volume access mode must be snapMirrorTarget. + + long + + + + SnapshotID + + Roll back the volume to the snapshot identified by this ID. The default behavior is to roll back to the most recent snapshot. + + long + + + + Preserve + + Preserve any snapshots newer than the snapshot identified by snapshotID. Possible values: true: Preserve snapshots newer than snapshotID. false: Do not preserve snapshots newer than snapshotID. If false, any snapshots newer than snapshotID are deleted. + + bool + + + + Access + + Resulting volume access mode. Possible values: readWrite, readOnly, locked. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Access + + Resulting volume access mode. Possible values: readWrite, readOnly, locked. + + string + + string + + + + + Preserve + + Preserve any snapshots newer than the snapshot identified by snapshotID. Possible values: true: Preserve snapshots newer than snapshotID. false: Do not preserve snapshots newer than snapshotID. If false, any snapshots newer than snapshotID are deleted. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + Roll back the volume to the snapshot identified by this ID. The default behavior is to roll back to the most recent snapshot. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + The volume on which to perform the break operation. The volume access mode must be snapMirrorTarget. + + long + + long + + + + + + + + None + + + + + + + + + + + + + BreakSnapMirrorVolumeResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_BreakSnapMirrorVolumeResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFBreakSnapMirrorVolume -VolumeID $solidfireVolume.VolumeID + + This can only be done if the volume access mode is "snapMirrorTarget". That step cannot be done through the SF PowerShell Module. + + + + + + + Invoke-SFQuiesceSnapMirrorRelationship + + [Cluster] Invoke-SFQuiesceSnapMirrorRelationship disables future data transfers for a SnapMirror relationship. If a transfer is in progress, the relationship status becomes "quiescing" until the transfer is complete. If the current transfer is aborted, it will not restart. You can reenable data transfers for the relationship using the Resume-SFSnapMirrorRelationship commandlet. + + + + + Invoke + SFQuiesceSnapMirrorRelationship + + + + [Cluster] Invoke-SFQuiesceSnapMirrorRelationship disables future data transfers for a SnapMirror relationship. If a transfer is in progress, the relationship status becomes "quiescing" until the transfer is complete. If the current transfer is aborted, it will not restart. You can reenable data transfers for the relationship using the Resume-SFSnapMirrorRelationship commandlet. + + + + Invoke-SFQuiesceSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + QuiesceSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_QuiesceSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFQuiesceSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Quiesces the target relationship. + + + + + + + Invoke-SFRestoreDeletedVolume + + [Cluster] Marks a deleted volume as active again. + + + + + Invoke + SFRestoreDeletedVolume + + + + [Cluster] Marks a deleted volume as active again. + + + + Invoke-SFRestoreDeletedVolume + + VolumeID + + Enter a VolumeID for the deleted volume to restore. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a VolumeID for the deleted volume to restore. + + long + + long + + + + + + + + System.Int64 + + + + + + + + + + + + + Volume + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFRestoreDeletedVolume -VolumeID 548 + + Restore volume ID 548 from a deleted state back to an active state. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFDeletedVolume | Invoke-SFRestoreDeletedVolume + + Restore all volumes that are currently deleted. + + + + + + + Invoke-SFRollbackToGroupSnapshot + + [Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot. + + + + + Invoke + SFRollbackToGroupSnapshot + + + + [Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot. + + + + Invoke-SFRollbackToGroupSnapshot + + GroupSnapshotID + + Enter a GroupSnapshotID for the volume to restore. + + long + + + + Name + + Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name. + + string + + + + SaveCurrentState + + true: The previous active volume image is kept. false: (default) The previous active volume image is deleted. + + bool + + + + Attributes + + Attributes to set + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + GroupSnapshotID + + Enter a GroupSnapshotID for the volume to restore. + + long + + long + + + + + Name + + Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SaveCurrentState + + true: The previous active volume image is kept. false: (default) The previous active volume image is deleted. + + bool + + bool + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +System.Boolean + + + + + + + + + + + + + CreateGroupSnapshotResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateGroupSnapshotResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFRollbackToGroupSnapshot -GroupSnapshotID 30 + + Rolls the group of volumes back to the specified group snapshot but does not preserve the current state. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Invoke-SFRollbackToGroupSnapshot -GroupSnapshotID 30 -SaveCurrentState:$true -Name CurrentStateGroupSnapshot + + Rolls the group of volumes back to the specified group snapshot. In this case, the command first takes a new group snapshot of the current volumes' state named "CurrentStateGroupSnapshot" prior to rolling back to the snapshot. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolume -Name RCLPSMTestVol-02 | Get-SFGroupSnapshot -GroupSnapshotName Tuesday | Invoke-SFRollbackToGroupSnapshot -SaveCurrentState:$true -Name CurrentStateGroupSnapsnot + + Finds the group snapshot named "Tuesday" where the volume "RCLPSMTestVol-02" is a member. Then rolls back to this snapshot while saving the current state as a new group snapshot "CurrentStateGroupSnapshot" + + + + + + + Invoke-SFRollbackToSnapshot + + [Cluster] Makes an existing snapshot the "active" volume image. + + + + + Invoke + SFRollbackToSnapshot + + + + [Cluster] Makes an existing snapshot the "active" volume image. + + + + Invoke-SFRollbackToSnapshot + + VolumeID + + Enter a VolumeID for the volume to restore. + + long + + + + SnapshotID + + Enter the SnapshotID of a previously created snapshot on the given volume. + + long + + + + Name + + Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name. + + string + + + + SaveCurrentState + + true: The previous active volume image is kept. false: (default) The previous active volume image is deleted. + + bool + + + + Attributes + + Attributes to set + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + Name + + Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SaveCurrentState + + true: The previous active volume image is kept. false: (default) The previous active volume image is deleted. + + bool + + bool + + + + + SnapshotID + + Enter the SnapshotID of a previously created snapshot on the given volume. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a VolumeID for the volume to restore. + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +System.Boolean + + + + + + + + + + + + + CreateSnapshotResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapshotResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFRollbackToSnapshot -VolumeID 477 -SnapshotID 2506 + + Rolls the volume back to the specified snapshot but does not preserve the current state. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Invoke-SFRollbackToSnapshot -VolumeID 477 -SnapshotID 2506 -SaveCurrentState:$true -Name CurrentStateSnapshot + + Rolls the volume back to the specified snapshot. In this case, the command first takes a new snapshot of the current state named "CurrentStateSnapshot" prior to rolling back to the snapshot. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolume -Name SampleVol01 | Get-SFSnapshot -SnapshotName Tuesday | Invoke-SFRollbackToSnapshot -SaveCurrentState:$true -Name CurrentStateSnapshot + + Rolls back the volume named "SampleVol01" to the snapshot named "Tuesday" and saves the current state to a new snapshot named "CurrentStateSnapshot". + + + + + + + Invoke-SFSecureEraseDrive + + [Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive. + + + + + Invoke + SFSecureEraseDrive + + + + [Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive. + + + + Invoke-SFSecureEraseDrive + + DriveID + + Enter a drive ID or list of drive IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Invoke-SFSecureEraseDrive + + Drive + + Please pass in a SFDrive or list of SFDrives + + DriveInfo[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Drive + + Please pass in a SFDrive or list of SFDrives + + DriveInfo[] + + DriveInfo[] + + + + + DriveID + + Enter a drive ID or list of drive IDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +SolidFire.Element.Api.DriveInfo[] + + + + + + + + + + + + + AsyncHandleResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AsyncHandleResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFSecureEraseDrive -DriveID 19 + Begins the secure erase process on drive ID 19. -Note: Drives must be removed (changed to an "available" status) before being secure erased. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Note: Drives must be removed (changed to an "available" status) before being secure erased. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $drives = Get-SFDrive -Invoke-SFSecureEraseDrive -Drive $drives[3] - +Invoke-SFSecureEraseDrive -Drive $drives[3] + Begins the secure erase process on a drive recieved from Get command. -Note: Drives must be removed (changed to an "available" status) before being secure erased. - - - - - - - Invoke-SFShutdown - - [Cluster] Shutdown one or more nodes in a cluster. - - - - - Invoke - SFShutdown - - - - You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method. - - - - Confirm - - You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method. - - - switch - - - - - - NodeID - - List of NodeIDs for the nodes to be shutdown. - - long[] - - long[] - - - - - - Option - - Action to take for the node shutdown: restart or halt. Default is restart. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method. - - - switch - - - - - - - - - System.Int64[] - - - - - You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method. - - - - - - - - - - ShutdownResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ShutdownResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Invoke-SFShutdown -NodeID 1,2,3,4 - - Shuts down nodes 1 thorugh 4 - - - - - - - New-SFAccount - - [Cluster] Adds a new account to the system. - - - - - New - SFAccount - - - - [Cluster] Adds a new account to the system. - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - InitiatorSecret - - CHAP secret to use for the initiator - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - TargetSecret - - CHAP secret to use for the target - - string - - string - - - - - - Username - - Unique username for this account - - string - - string - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String -System.Collections.Hashtable - - - - - [Cluster] Adds a new account to the system. - - - - - - - - - - Account - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFAccount -Username User1 - - The -Username parameter does not have to be specified in this scenario. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFAccount -Username User1 -InitiatorSecret 3ks03ks02l4@1k -TargetSecret 3ks03ks02l4@!l - - Creates a new tennant account "User1" with the specified CHAP secrets. - - - - - - - New-SFClone - - [Cluster] Creates a copy of the volume. - - - - - New - SFClone - - - - [Cluster] Creates a copy of the volume. - - - - Access - - Access allowed for the new volume - - string - - string - - - - - - Attributes - - List of Name/Value pairs as a hashtable - - hashtable - - hashtable - - - - - - Name - - Name of the new cloned volume - - string - - string - - - - - - NewAccountID - - AccountID of the owner of the volume - - long - - long - - - - - - NewSize - - New size of the volume in Gigabytes - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - ID of the snapshot that is used as the source of the clone - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Volume ID for the volume to be cloned - - long - - long - - - - - - - - - System.Int64 -System.String -System.Collections.Hashtable - - - - - [Cluster] Creates a copy of the volume. - - - - - - - - - - CloneVolumeResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CloneVolumeResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFClone -VolumeID 29 -Name NewVolume - - Creates a clone of volume ID 29 and names the new volume "NewVolume". - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFClone -VolumeID 29 -Name NewVolume -NewAccountID 3 -NewSize 100000000000 -Access readOnly - - Creates a clone of volume ID 29 and names the new volume "NewVolume". This command also associates the new volume with account ID 3, changes the size of the volume to 100 GB (100000000000 Bytes) and changes the access to readOnly. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - New-SFClone -VolumeID 29 -Name NewVolume -SnapshotID 27 - - Creates a clone of snapshot ID 27 on volume ID 29 and names the new volume "NewVolume". - - - - - - - New-SFCloneMultiple - - [Cluster] Creates a clone of a group of specified volumes. - - - - - New - SFCloneMultiple - - - - [Cluster] Creates a clone of a group of specified volumes. - - - - Access - - New default access method for the new volumes if not overridden by information passed in the Volumes array. - - string - - string - - - - - - GroupSnapshotID - - ID of the group snapshot to use as a basis for the clone. - - long - - long - - - - - - NewAccountID - - New account ID for the volumes if not overridden by information passed in the Volumes array. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Volume - - Unique SFCloneVolume for each volume to include in the clone. If optional parameters are not specified, the values will be inherited from the source volumes. - - CloneMultipleVolumeParams[] - - CloneMultipleVolumeParams[] - - - - - - VolumeID - - Unique ID for each volume to include in the clone. Default values will be inherited from the source volumes. - - long[] - - long[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Creates a clone of a group of specified volumes. - - - - - - - - - - CloneMultipleVolumesResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CloneMultipleVolumesResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFCloneMultiple -VolumeID 23,25 - - Clone the specified volumes. Volume details all remain the same including name, account, size, QoS and access. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolume -Name "*VM*" | New-SFCloneMultiple -NewAccountID 20 - - Clone all of the volumes that include "VM" in the name and associate the new clones with Account ID 20. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - New-SFCloneMultiple -GroupSnapshotID 3 - - Create a clone of each volume included in the identified group snapshot. - - - - - - - New-SFCluster - - [Cluster] Creates a new SolidFire cluster from a list of node SIPs that are configured with the same cluster name. - - - - - New - SFCluster - - - - [Cluster] Creates a new SolidFire cluster from a list of nodes that are configured with the same cluster name. - - - - AcceptEula - - Include this switch parameter if you accept the EULA. - - - switch - - - - - - Attributes - - Dictionary of name/values - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - Mvip - - Floating (virtual) IP address for the cluster on the management network - - string - - string - - - - - - Nodes - - IP addresses of the initial set of nodes making up the cluster. This node's IP must be on the list - - string[] - - string[] - - - - - - Password - - Initial password for the cluster admin account - - string - - string - - - - - - ReplicaCount - - Number of replicas of each piece of data to store in the cluster - - int - - int - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Svip - - Floating (virtual) IP address for the cluster on the storage (iSCSI) network - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - Username - - User name for the cluster admin - - string - - string - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String -System.String[] -System.Int32 -System.Collections.Hashtable - - - - - [Cluster] Creates a new SolidFire cluster from a list of nodes that are configured with the same cluster name. - - - - - - - - - - CreateClusterResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateClusterResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFCluster -Mvip 10.10.1.1 -Svip 10.10.10.1 -Username admin -Password pass -Nodes "10.10.10.11","10.10.10.12","10.10.10.13","10.10.10.14" - - Creates a new SolidFire cluster with the specified nodes. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Note: Drives must be removed (changed to an "available" status) before being secure erased. + + + + + + + Invoke-SFShutdown + + [Cluster] Shutdown one or more nodes in a cluster. + + + + + Invoke + SFShutdown + + + + You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method. + + + + Invoke-SFShutdown + + NodeID + + List of NodeIDs for the nodes to be shutdown. + + long[] + + + + Option + + Action to take for the node shutdown: restart or halt. Default is restart. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + NodeID + + List of NodeIDs for the nodes to be shutdown. + + long[] + + long[] + + + + + Option + + Action to take for the node shutdown: restart or halt. Default is restart. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + + + + ShutdownResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ShutdownResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Invoke-SFShutdown -NodeID 1,2,3,4 + + Shuts down nodes 1 thorugh 4 + + + + + + + New-SFAccount + + [Cluster] Adds a new account to the system. + + + + + New + SFAccount + + + + [Cluster] Adds a new account to the system. + + + + New-SFAccount + + Username + + Unique username for this account + + string + + + + InitiatorSecret + + CHAP secret to use for the initiator + + string + + + + TargetSecret + + CHAP secret to use for the target + + string + + + + Attributes + + Attributes to set + + hashtable + + + + EnableChap + + Specify if chap account credentials can be used by an initiator to access volumes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + EnableChap + + Specify if chap account credentials can be used by an initiator to access volumes. + + + switch + + + + + InitiatorSecret + + CHAP secret to use for the initiator + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TargetSecret + + CHAP secret to use for the target + + string + + string + + + + + Username + + Unique username for this account + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.String +System.Collections.Hashtable + + + + + + + + + + + + + Account + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFAccount -Username User1 + + The -Username parameter does not have to be specified in this scenario. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFAccount -Username User1 -InitiatorSecret 3ks03ks02l4@1k -TargetSecret 3ks03ks02l4@!l + + Creates a new tennant account "User1" with the specified CHAP secrets. + + + + + + + New-SFClone + + [Cluster] Creates a copy of the volume. + + + + + New + SFClone + + + + [Cluster] Creates a copy of the volume. + + + + New-SFClone + + VolumeID + + Volume ID for the volume to be cloned + + long + + + + Name + + Name of the new cloned volume + + string + + + + NewAccountID + + AccountID of the owner of the volume + + long + + + + NewSize + + New size of the volume in Gigabytes + + long + + + + Access + + Access allowed for the new volume + + string + + + + SnapshotID + + ID of the snapshot that is used as the source of the clone + + long + + + + Attributes + + List of Name/Value pairs as a hashtable + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Access + + Access allowed for the new volume + + string + + string + + + + + Attributes + + List of Name/Value pairs as a hashtable + + hashtable + + hashtable + + + + + Name + + Name of the new cloned volume + + string + + string + + + + + NewAccountID + + AccountID of the owner of the volume + + long + + long + + + + + NewSize + + New size of the volume in Gigabytes + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + ID of the snapshot that is used as the source of the clone + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Volume ID for the volume to be cloned + + long + + long + + + + + + + + System.Int64 +System.String +System.Collections.Hashtable + + + + + + + + + + + + + CloneVolumeResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CloneVolumeResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFClone -VolumeID 29 -Name NewVolume + + Creates a clone of volume ID 29 and names the new volume "NewVolume". + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFClone -VolumeID 29 -Name NewVolume -NewAccountID 3 -NewSize 100000000000 -Access readOnly + + Creates a clone of volume ID 29 and names the new volume "NewVolume". This command also associates the new volume with account ID 3, changes the size of the volume to 100 GB (100000000000 Bytes) and changes the access to readOnly. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFClone -VolumeID 29 -Name NewVolume -SnapshotID 27 + + Creates a clone of snapshot ID 27 on volume ID 29 and names the new volume "NewVolume". + + + + + + + New-SFCloneMultiple + + [Cluster] Creates a clone of a group of specified volumes. + + + + + New + SFCloneMultiple + + + + [Cluster] Creates a clone of a group of specified volumes. + + + + New-SFCloneMultiple + + Volume + + Unique SFCloneVolume for each volume to include in the clone. If optional parameters are not specified, the values will be inherited from the source volumes. + + CloneMultipleVolumeParams[] + + + + Access + + New default access method for the new volumes if not overridden by information passed in the Volumes array. + + string + + + + GroupSnapshotID + + ID of the group snapshot to use as a basis for the clone. + + long + + + + NewAccountID + + New account ID for the volumes if not overridden by information passed in the Volumes array. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + New-SFCloneMultiple + + VolumeID + + Unique ID for each volume to include in the clone. Default values will be inherited from the source volumes. + + long[] + + + + Access + + New default access method for the new volumes if not overridden by information passed in the Volumes array. + + string + + + + GroupSnapshotID + + ID of the group snapshot to use as a basis for the clone. + + long + + + + NewAccountID + + New account ID for the volumes if not overridden by information passed in the Volumes array. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Access + + New default access method for the new volumes if not overridden by information passed in the Volumes array. + + string + + string + + + + + GroupSnapshotID + + ID of the group snapshot to use as a basis for the clone. + + long + + long + + + + + NewAccountID + + New account ID for the volumes if not overridden by information passed in the Volumes array. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Volume + + Unique SFCloneVolume for each volume to include in the clone. If optional parameters are not specified, the values will be inherited from the source volumes. + + CloneMultipleVolumeParams[] + + CloneMultipleVolumeParams[] + + + + + VolumeID + + Unique ID for each volume to include in the clone. Default values will be inherited from the source volumes. + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + CloneMultipleVolumesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CloneMultipleVolumesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFCloneMultiple -VolumeID 23,25 + + Clone the specified volumes. Volume details all remain the same including name, account, size, QoS and access. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "*VM*" | New-SFCloneMultiple -NewAccountID 20 + + Clone all of the volumes that include "VM" in the name and associate the new clones with Account ID 20. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFCloneMultiple -GroupSnapshotID 3 + + Create a clone of each volume included in the identified group snapshot. + + + + + + + New-SFCluster + + [Cluster] Creates a new SolidFire cluster from a list of node SIPs that are configured with the same cluster name. + + + + + New + SFCluster + + + + [Cluster] Creates a new SolidFire cluster from a list of nodes that are configured with the same cluster name. + + + + New-SFCluster + + Mvip + + Floating (virtual) IP address for the cluster on the management network + + string + + + + Svip + + Floating (virtual) IP address for the cluster on the storage (iSCSI) network + + string + + + + Username + + User name for the cluster admin + + string + + + + Password + + Initial password for the cluster admin account + + string + + + + Nodes + + IP addresses of the initial set of nodes making up the cluster. This node's IP must be on the list + + string[] + + + + ReplicaCount + + Number of replicas of each piece of data to store in the cluster + + int + + + + Attributes + + Dictionary of name/values + + hashtable + + + + SerialNumber + + The Serial Number for this cluster + + string + + + + OrderNumber + + The sales order number for this cluster + + string + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + + + EnableSoftwareEncryptionAtRest + + Enable this flag to use software-based encryption-at-rest. Defaults to true on SolidFire software-only clusters. Defaults to false on all other clusters. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + switch + + + + + Attributes + + Dictionary of name/values + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + EnableSoftwareEncryptionAtRest + + Enable this flag to use software-based encryption-at-rest. Defaults to true on SolidFire software-only clusters. Defaults to false on all other clusters. + + + switch + + + + + Mvip + + Floating (virtual) IP address for the cluster on the management network + + string + + string + + + + + Nodes + + IP addresses of the initial set of nodes making up the cluster. This node's IP must be on the list + + string[] + + string[] + + + + + OrderNumber + + The sales order number for this cluster + + string + + string + + + + + Password + + Initial password for the cluster admin account + + string + + string + + + + + ReplicaCount + + Number of replicas of each piece of data to store in the cluster + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SerialNumber + + The Serial Number for this cluster + + string + + string + + + + + Svip + + Floating (virtual) IP address for the cluster on the storage (iSCSI) network + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + User name for the cluster admin + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.String +System.String[] +System.Int32 +System.Collections.Hashtable + + + + + + + + + + + + + CreateClusterResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateClusterResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFCluster -Mvip 10.10.1.1 -Svip 10.10.10.1 -Username admin -Password pass -Nodes "10.10.10.11","10.10.10.12","10.10.10.13","10.10.10.14" + + Creates a new SolidFire cluster with the specified nodes. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + Connect-SFCluster 172.27.153.41 -Username "fake" -Password "fake" -Node -New-SFCluster -Mvip 172.27.153.46 -Svip 172.27.151.46 -Username clusteradmin -Password clusterpass -Nodes (Get-SFBootstrapConfig).Nodes.Name - - Connects to one of the nodes to be included in the newly created cluster with fake credentials (credentials are only used after a cluster has been created). New-SFCluster is then called with the node IPs being pulled directly from Get-SFBootstrapConfig. - - - - - - - New-SFClusterAdmin - - [Cluster] Adds a new cluster admin. - - - - - New - SFClusterAdmin - - - - [Cluster] Adds a new cluster admin. - - - - AcceptEula - - Include this switch parameter if you accept the EULA. - - - switch - - - - - - Access - - Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API. - - string[] - - string[] - - - - - - Attributes - - List of Name/Value pairs in JSON object format. - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - Password - - Password used to authenticate this Cluster Admin. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Username - - Unique username for this Cluster Admin. - - string - - string - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String -System.String[] - - - - - [Cluster] Adds a new cluster admin. - - - - - - - - - - ClusterAdmin - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFClusterAdmin -Username AdminUser -Password NewPass -Access "nodes","drives" - +New-SFCluster -Mvip 172.27.153.46 -Svip 172.27.151.46 -Username clusteradmin -Password clusterpass -Nodes (Get-SFBootstrapConfig).Nodes.Name + + Connects to one of the nodes to be included in the newly created cluster with fake credentials (credentials are only used after a cluster has been created). New-SFCluster is then called with the node IPs being pulled directly from Get-SFBootstrapConfig. + + + + + + + New-SFClusterAdmin + + [Cluster] Adds a new cluster admin. + + + + + New + SFClusterAdmin + + + + [Cluster] Adds a new cluster admin. + + + + New-SFClusterAdmin + + Username + + Unique username for this Cluster Admin. Username is not case sensitive. + + string + + + + Password + + Password used to authenticate this Cluster Admin. + + string + + + + Access + + Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API. + + string[] + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + switch + + + + + Access + + Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API. + + string[] + + string[] + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + Password + + Password used to authenticate this Cluster Admin. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + Unique username for this Cluster Admin. Username is not case sensitive. + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.String +System.String[] + + + + + + + + + + + + + ClusterAdmin + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFClusterAdmin -Username AdminUser -Password NewPass -Access "nodes","drives" + Adds a cluster admin user with full access to the "nodes" and "drives" groups of API methods. The most common access levels are: "administrator" - Full access to all API methods -"reporting" - Access to only readonly API methods with some limitations - - - - - - - New-SFGroupSnapshot - - [Cluster] Creates a point-in-time snapshot of a group of volumes. - - - - - New - SFGroupSnapshot - - - - [Cluster] Creates a point-in-time snapshot of a group of volumes. - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - EnableRemoteReplication - - Should the snapsnot be replicated to remote storage? - - - switch - - - - - - Name - - Name for the snapshot group - - string - - string - - - - - - Retention - - The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Unique ID of the volume image from which to copy - - long[] - - long[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Creates a point-in-time snapshot of a group of volumes. - - - - - - - - - - GroupSnapshot - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFGroupSnapshot -VolumeID 12,13,14 -Name GroupSnap01 - - Creates a group snapshot named "GroupSnap01" including the specified volumes. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolume -Name "*VMware*" | New-SFGroupSnapshot -Name VMwareSnap - - Creates a new group snapshot named "VMwareSnap" that includes all volumes on the cluster with "VMware" in the volume name. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - New-SFGroupSnapshot -VolumeID 4,5 -Name testSnap -Retention 50:00:00 -EnableRemoteReplication:$true - - Creates a new GroupSnapshot named "testSnap" using volume ID 4 and 5. The snapshot is set to be retained for 50 hours and remote replication is enabled. - - - - - - - New-SFInitiator - - Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes. - - - - - New - SFInitiator - - - - Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes. - - - - Alias - - The friendly name to assign to this initiator. - - string - - string - - - - - - Attributes - - A set of Hashtable attributes assigned to this initiator. - - hashtable - - hashtable - - - - - - Name - - The name of the initiator (IQN or WWPN) to create. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - The ID of the volume access group into to which this newly created initiator will be added. - - long - - long - - - - - - - - - None - - - - - Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFInitiator -Name test - - Creates a new initiator with name "test". - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFInitiator -Name test2 -Alias t2 - - Creates a new initiator with name "test2" and alias "t2". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - New-SFInitiator -Name test -VolumeAccessGroupID 1 - - Creates a new initiator with name "test" and adds it to VolumeAccessGroup ID 1. - - - - - - - New-SFLdapClusterAdmin - - [Cluster] Adds a new LDAP cluster admin. - - - - - New - SFLdapClusterAdmin - - - - [Cluster] Adds a new LDAP cluster admin. - - - - AcceptEula - - Include this switch parameter if you accept the EULA. - - - switch - - - - - - Access - - Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix in the SolidFire API Reference. - - string[] - - string[] - - - - - - Attributes - - List of Name/Value pairs in JSON object format. - - hashtable - - hashtable - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Username - - The distinguished user name for the new LDAP cluster admin. - - string - - string - - - - - - - - - System.String -System.String[] - - - - - [Cluster] Adds a new LDAP cluster admin. - - - - - - - - - - ClusterAdmin - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFLdapClusterAdmin -Username admin -Access administrator -AcceptEula:$true - - Creates a new SFLdapClusterAdmin with username "admin" and gives it full administrator access. Auto accepts the EULA. - - - - - - - New-SFNodeSupportBundle - - [Node] Creates a support bundle file under the node's directory. - - - - - New - SFNodeSupportBundle - - - - [Node] Creates a support bundle file under the node's directory. - - - - BundleName - - Unique name for each support bundle created. If no name is provided, then 'supportbundle' and the node name is used as a file name. - - string - - string - - - - - - ExtraArgs - - This parameter is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - TimeoutSec - - This parameter overrides the Timeout parameter in the SFConnection object. It is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support. - - int - - int - - - - - - - - - System.String -System.Int32 - - - - - [Node] Creates a support bundle file under the node's directory. - - - - - - - - - - CreateSupportBundleResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSupportBundleResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFNodeSupportBundle -BundleName "TestBundle" -TimeoutSec 180 - +"reporting" - Access to only readonly API methods with some limitations + + + + + + + New-SFGroupSnapshot + + [Cluster] Creates a point-in-time snapshot of a group of volumes. + + + + + New + SFGroupSnapshot + + + + [Cluster] Creates a point-in-time snapshot of a group of volumes. + + + + New-SFGroupSnapshot + + VolumeID + + Unique ID of the volume image from which to copy + + long[] + + + + Name + + Name for the snapshot group + + string + + + + EnableRemoteReplication + + Should the snapsnot be replicated to remote storage? + + + + + Retention + + The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 + + string + + + + Attributes + + Attributes to set + + hashtable + + + + EnsureSerialCreation + + Specify if the snapshot creation should be failed if a previous snapshot replication is in progress. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + EnableRemoteReplication + + Should the snapsnot be replicated to remote storage? + + + switch + + + + + EnsureSerialCreation + + Specify if the snapshot creation should be failed if a previous snapshot replication is in progress. + + + switch + + + + + Name + + Name for the snapshot group + + string + + string + + + + + Retention + + The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Unique ID of the volume image from which to copy + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + GroupSnapshot + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFGroupSnapshot -VolumeID 12,13,14 -Name GroupSnap01 + + Creates a group snapshot named "GroupSnap01" including the specified volumes. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "*VMware*" | New-SFGroupSnapshot -Name VMwareSnap + + Creates a new group snapshot named "VMwareSnap" that includes all volumes on the cluster with "VMware" in the volume name. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFGroupSnapshot -VolumeID 4,5 -Name testSnap -Retention 50:00:00 -EnableRemoteReplication:$true + + Creates a new GroupSnapshot named "testSnap" using volume ID 4 and 5. The snapshot is set to be retained for 50 hours and remote replication is enabled. + + + + + + + New-SFIdpClusterAdmin + + [Cluster] Adds a cluster administrator user authenticated by a third party Identity Provider (IdP). + + + + + New + SFIdpClusterAdmin + + + + [Cluster] Adds a cluster administrator user authenticated by a third party Identity Provider (IdP). + + + + New-SFIdpClusterAdmin + + Username + + A SAML attribute-value mapping to a IdP cluster admin (e.g. email=test@example.com). + + string + + + + Access + + Controls which methods this IdP Cluster Admin can use. Valid values are read,nodes,reporting,drives,volumes,accounts,administrator. + + string[] + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + switch + + + + + Access + + Controls which methods this IdP Cluster Admin can use. Valid values are read,nodes,reporting,drives,volumes,accounts,administrator. + + string[] + + string[] + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + A SAML attribute-value mapping to a IdP cluster admin (e.g. email=test@example.com). + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.String +System.String[] + + + + + + + + + + + + + ClusterAdmin[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFIdpClusterAdmin -Username user1 -Access administrator -AcceptEula + + Adds a IDP cluster administrator with Username user1 + + + + + + + New-SFIdpConfiguration + + [Cluster] Create a potential trust relationship for authentication using a third party Identity Provider (IdP) for the cluster. + + + + + New + SFIdpConfiguration + + + + [Cluster] Create a potential trust relationship for authentication using a third party Identity Provider (IdP) for the cluster. + + + + New-SFIdpConfiguration + + IdpName + + Name used to identify an IdP provider for SAML 2.0 single sign-on. + + string + + + + IdpMetadata + + IdP Metadata to store. IdP metadata, in plain text format, is retrieved from the third-party IdP. This metadata needs to be validated to ensure that it is correctly formatted in JSON. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + IdpMetadata + + IdP Metadata to store. IdP metadata, in plain text format, is retrieved from the third-party IdP. This metadata needs to be validated to ensure that it is correctly formatted in JSON. + + string + + string + + + + + IdpName + + Name used to identify an IdP provider for SAML 2.0 single sign-on. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.String + + + + + + + + + + + + + IdpConfigInfo + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFIdpConfiguration -IdpName adfsidp -IdpMetadata <adfsmetadata> + + Create a IDP Configuration for the cluster with IdpName adfsidp and IdpMetadata <adfsmetadata> + + + + + + + New-SFInitiator + + Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes. + + + + + New + SFInitiator + + + + Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes. + + + + New-SFInitiator + + Name + + The name of the initiator (IQN or WWPN) to create. + + string + + + + Alias + + The friendly name to assign to this initiator. + + string + + + + VolumeAccessGroupID + + The ID of the volume access group into to which this newly created initiator will be added. + + long + + + + Attributes + + A set of Hashtable attributes assigned to this initiator. + + hashtable + + + + RequireChap + + RequireChap determines if the initiator is required to use CHAP during session login. CHAP is optional if RequireChap is false. + + + + + ChapUsername + + The CHAP username for this initiator. Defaults to the initiator name (IQN) if not specified during creation and RequireChap is true. + + string + + + + InitiatorSecret + + The CHAP secret used for authentication of the initiator. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + + + TargetSecret + + The CHAP secret used for authentication of the target. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + + + VirtualNetworkIDs + + The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Alias + + The friendly name to assign to this initiator. + + string + + string + + + + + Attributes + + A set of Hashtable attributes assigned to this initiator. + + hashtable + + hashtable + + + + + ChapUsername + + The CHAP username for this initiator. Defaults to the initiator name (IQN) if not specified during creation and RequireChap is true. + + string + + string + + + + + InitiatorSecret + + The CHAP secret used for authentication of the initiator. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + string + + + + + Name + + The name of the initiator (IQN or WWPN) to create. + + string + + string + + + + + RequireChap + + RequireChap determines if the initiator is required to use CHAP during session login. CHAP is optional if RequireChap is false. + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TargetSecret + + The CHAP secret used for authentication of the target. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + string + + + + + VirtualNetworkIDs + + The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks. + + long[] + + long[] + + + + + VolumeAccessGroupID + + The ID of the volume access group into to which this newly created initiator will be added. + + long + + long + + + + + + + + System.String +System.Int64[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFInitiator -Name iqn.1991-05.com.microsoft:sf-1a2b3c + + Creates a new initiator with name "iqn.1991-05.com.microsoft:sf-1a2b3c". + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFInitiator -Name iqn.1991-05.com.microsoft:sf-1a2b3c -Alias test + + Creates a new initiator with name "iqn.1991-05.com.microsoft:sf-1a2b3c" and alias "test". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFInitiator -Name iqn.1991-05.com.microsoft:sf-1a2b3c -VolumeAccessGroupID 1 + + Creates a new initiator with name "iqn.1991-05.com.microsoft:sf-1a2b3c" and adds it to VolumeAccessGroup ID 1. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFInitiator -Name iqn.1991-05.com.microsoft:sf-1a2b3c -RequireChap + + Creates a new initiator with name "iqn.1991-05.com.microsoft:sf-1a2b3c" and will set Chap to be required during session login. + + + + + + + New-SFKeyProviderKmip + + [Cluster] Creates a KMIP (Key Management Interoperability Protocol) Key Provider + + + + + New + SFKeyProviderKmip + + + + [Cluster] A Key Provider defines a mechanism and location to retrieve authentication keys. A KMIP Key Provider represents a collection of one or more KMIP Key Servers. A newly created KMIP Key Provider will not have any KMIP Key Servers assigned to it. To create a KMIP Key Server see CreateKeyServerKmip and to assign it to a provider created via this method see AddKeyServerToProviderKmip. + + + + New-SFKeyProviderKmip + + KeyProviderName + + The name to associate with the created KMIP Key Provider. This name is only used for display purposes and does not need to be unique. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyProviderName + + The name to associate with the created KMIP Key Provider. This name is only used for display purposes and does not need to be unique. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + KeyProviderKmip + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFKeyProviderKmip -KeyProviderName "MyKeyServer" + + Adds a key server with the name MyKeyServer + + + + + + + New-SFKeyServerKmip + + [Cluster] Creates a KMIP (Key Management Interoperability Protocol) Key Provider + + + + + New + SFKeyServerKmip + + + + [Cluster] Creates a KMIP (Key Management Interoperability Protocol) Key Server with the specified attributes. The server will not be contacted as part of this operation so it need not exist or be configured prior. For clustered Key Server configurations, the hostnames or IP Addresses, of all server nodes, must be provided in the kmipKeyServerHostnames parameter. + + + + New-SFKeyServerKmip + + KmipCaCertificate + + The public key certificate of the external key server's root CA. This will be used to verify the certificate presented by external key server in the TLS communication. For key server clusters where individual servers use different CAs, provide a concatenated string containing the root certificates of all the CAs. + + string + + + + KmipClientCertificate + + A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client. + + string + + + + KmipKeyServerHostnames + + Array of the hostnames or IP addresses associated with this KMIP Key Server. Multiple hostnames or IP addresses must only be provided if the key servers are in a clustered configuration. + + string[] + + + + KmipKeyServerName + + The name of the KMIP Key Server. This name is only used for display purposes and does not need to be unique. + + string + + + + KmipKeyServerPort + + The port number associated with this KMIP Key Server (typically 5696). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KmipCaCertificate + + The public key certificate of the external key server's root CA. This will be used to verify the certificate presented by external key server in the TLS communication. For key server clusters where individual servers use different CAs, provide a concatenated string containing the root certificates of all the CAs. + + string + + string + + + + + KmipClientCertificate + + A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client. + + string + + string + + + + + KmipKeyServerHostnames + + Array of the hostnames or IP addresses associated with this KMIP Key Server. Multiple hostnames or IP addresses must only be provided if the key servers are in a clustered configuration. + + string[] + + string[] + + + + + KmipKeyServerName + + The name of the KMIP Key Server. This name is only used for display purposes and does not need to be unique. + + string + + string + + + + + KmipKeyServerPort + + The port number associated with this KMIP Key Server (typically 5696). + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + KeyServerKmip + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFKeyServerKmip -KmipCaCertificate $ca -KmipClientCertificate -KmipKeyServerHostnames $hostname $client -KeyServerName "MyKeyServer" + + Adds a key server with the name MyKeyServer + + + + + + + New-SFLdapClusterAdmin + + [Cluster] Adds a new LDAP cluster admin. + + + + + New + SFLdapClusterAdmin + + + + [Cluster] Adds a new LDAP cluster admin. + + + + New-SFLdapClusterAdmin + + Username + + The distinguished user name for the new LDAP cluster admin. + + string + + + + Access + + Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix in the SolidFire API Reference. + + string[] + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AcceptEula + + Include this switch parameter if you accept the EULA. + + + switch + + + + + Access + + Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix in the SolidFire API Reference. + + string[] + + string[] + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + hashtable + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + The distinguished user name for the new LDAP cluster admin. + + string + + string + + + + + + + + System.String +System.String[] + + + + + + + + + + + + + ClusterAdmin + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFLdapClusterAdmin -Username admin -Access administrator -AcceptEula:$true + + Creates a new SFLdapClusterAdmin with username "admin" and gives it full administrator access. Auto accepts the EULA. + + + + + + + New-SFNodeSupportBundle + + [Node] Creates a support bundle file under the node's directory. + + + + + New + SFNodeSupportBundle + + + + [Node] Creates a support bundle file under the node's directory. + + + + New-SFNodeSupportBundle + + BundleName + + Unique name for each support bundle created. If no name is provided, then 'supportbundle' and the node name is used as a file name. + + string + + + + ExtraArgs + + This parameter is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support. + + string + + + + TimeoutSec + + This parameter overrides the Timeout parameter in the SFConnection object. It is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + BundleName + + Unique name for each support bundle created. If no name is provided, then 'supportbundle' and the node name is used as a file name. + + string + + string + + + + + ExtraArgs + + This parameter is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TimeoutSec + + This parameter overrides the Timeout parameter in the SFConnection object. It is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support. + + int + + int + + + + + + + + System.String +System.Int32 + + + + + + + + + + + + + CreateSupportBundleResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSupportBundleResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFNodeSupportBundle -BundleName "TestBundle" -TimeoutSec 180 + Creates a new support bundle named "TestBundle". -It is recommended to use a value greater than 60 for "TimeoutSec". Using a value higher than the expected time to create a support bundle has no negative effects. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +It is recommended to use a value greater than 60 for "TimeoutSec". Using a value higher than the expected time to create a support bundle has no negative effects. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $bundle = New-SFNodeSupportBundle -BundleName "TestBundle" -TimeoutSec 180 $bundle.details.url will contain "https://[Target]:442/config/supportbundles/siteB.node1.tar" - - - Retrieve the created Support Bundle via the returned URL. - - - - - - - New-SFSchedule - - [Cluster] Creates a schedule that will make a snapshot of a volume. - - - - - New - SFSchedule - - - - [Cluster] Creates a schedule that will make a snapshot of a volume. - - - - EnableRemoteReplication - - Include snapshots in replication when paired. Default is false. - - bool - - bool - - - - - - Frequency - - Used to indicate the frequency at which the snapshot will be made. - - string - - string - - - - - - Paused - - Use to pause the schedule. - - bool - - bool - - - - - - Recurring - - Indicates if the schedule will be recurring or not. Default is true. - - bool - - bool - - - - - - RetentionDays - - Number of days to retain snapshots created by this schedule. - - uint64 - - uint64 - - - - - - RetentionHours - - Number of hours to retain snapshots created by this schedule. - - uint64 - - uint64 - - - - - - RetentionMinutes - - Number of minutes to retain snapshots created by this schedule. - - uint64 - - uint64 - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - ScheduleName - - Unique name for the schedule. - - string - - string - - - - - - SnapshotName - - Name of the new snapshot. - - string - - string - - - - - - StartingDate - - Date/Time after which the schedule will be run. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Volume IDs to be included in the resulting snapshots. - - long[] - - long[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Creates a schedule that will make a snapshot of a volume. - - - - - - - - - - Schedule - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFSchedule -VolumeID 8 -ScheduleName test -Frequency DaysOfWeek -DaysOfWeekDays Monday,Tuesday,Saturday - + + + Retrieve the created Support Bundle via the returned URL. + + + + + + + New-SFPublicPrivateKeyPair + + [Cluster] Create SSL public and private keys. + + + + + New + SFPublicPrivateKeyPair + + + + [Cluster] Creates SSL public and private keys. These keys can be used to generate Certificate Sign Requests. There can be only one key pair in use for the cluster. To replace the existing keys, make sure that they are not being used by any providers before invoking this API. + + + + New-SFPublicPrivateKeyPair + + CommonName + + This is the X.509 distinguished name Common Name field (CN). + + string + + + + Organization + + This is the X.509 distinguished name Organization Name field (O). + + string + + + + OrganizationalUnit + + This is the X.509 distinguished name Organizational Unit Name field (OU). + + string + + + + Locality + + This is the X.509 distinguished name Locality Name field (L). + + string + + + + State + + This is the X.509 distinguished name State or Province Name field (ST or SP or S). + + string + + + + Country + + This is the X.509 distinguished name Country field (C). + + string + + + + EmailAddress + + This is the X.509 distinguished name Email Address field (MAIL). + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + CommonName + + This is the X.509 distinguished name Common Name field (CN). + + string + + string + + + + + Country + + This is the X.509 distinguished name Country field (C). + + string + + string + + + + + EmailAddress + + This is the X.509 distinguished name Email Address field (MAIL). + + string + + string + + + + + Locality + + This is the X.509 distinguished name Locality Name field (L). + + string + + string + + + + + Organization + + This is the X.509 distinguished name Organization Name field (O). + + string + + string + + + + + OrganizationalUnit + + This is the X.509 distinguished name Organizational Unit Name field (OU). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + State + + This is the X.509 distinguished name State or Province Name field (ST or SP or S). + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + CreateKeyServerKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFPublicPrivateKeyPair + + Creates a new key pair with the default X.509 settings + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFPublicPrivateKeyPair -County "US" -State "CO" -Locality "Boulder" + + Creates a new key pair with the specified locality. + + + + + + + New-SFQoSPolicy + + [Cluster] Creates a new QoS Policy. + + + + + New + SFQoSPolicy + + + + [Cluster] Creates a new QoS Policy. + + + + New-SFQoSPolicy + + Name + + The name of the QoS policy + + string + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + int + + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + int + + + + + Confirm + + + + + switch + + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + int + + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + int + + + + + Name + + The name of the QoS policy + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFQoSPolicy -Name "Gold" -MinIOPS 10000 -MaxIOPS 125000 -BurstIOPS 200000 + + Creates a new QoS Policy named "Gold", with Min:Max:Burst IOPS of 10000:125000:200000. + + + + + + + New-SFSchedule + + [Cluster] Creates a schedule that will make a snapshot of a volume. + + + + + New + SFSchedule + + + + [Cluster] Creates a schedule that will make a snapshot of a volume. + + + + New-SFSchedule + + VolumeID + + Volume IDs to be included in the resulting snapshots. + + long[] + + + + ScheduleName + + Unique name for the schedule. + + string + + + + Frequency + + Used to indicate the frequency at which the snapshot will be made. + + string + + + + Paused + + Use to pause the schedule. + + bool + + + + SnapshotName + + Name of the new snapshot. + + string + + + + Recurring + + Indicates if the schedule will be recurring or not. Default is true. + + bool + + + + EnableRemoteReplication + + Include snapshots in replication when paired. Default is false. + + bool + + + + RetentionDays + + Number of days to retain snapshots created by this schedule. + + ulong + + + + RetentionHours + + Number of hours to retain snapshots created by this schedule. + + ulong + + + + RetentionMinutes + + Number of minutes to retain snapshots created by this schedule. + + ulong + + + + StartingDate + + Date/Time after which the schedule will be run. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + EnableRemoteReplication + + Include snapshots in replication when paired. Default is false. + + bool + + bool + + + + + Frequency + + Used to indicate the frequency at which the snapshot will be made. + + string + + string + + + + + Paused + + Use to pause the schedule. + + bool + + bool + + + + + Recurring + + Indicates if the schedule will be recurring or not. Default is true. + + bool + + bool + + + + + RetentionDays + + Number of days to retain snapshots created by this schedule. + + ulong + + ulong + + + + + RetentionHours + + Number of hours to retain snapshots created by this schedule. + + ulong + + ulong + + + + + RetentionMinutes + + Number of minutes to retain snapshots created by this schedule. + + ulong + + ulong + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + ScheduleName + + Unique name for the schedule. + + string + + string + + + + + SnapshotName + + Name of the new snapshot. + + string + + string + + + + + StartingDate + + Date/Time after which the schedule will be run. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Volume IDs to be included in the resulting snapshots. + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + Schedule + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFSchedule -VolumeID 8 -ScheduleName test -Frequency DaysOfWeek -DaysOfWeekDays Monday,Tuesday,Saturday + Creates a new schedule named "test" on volume 8, and sets the frequency to DaysOfWeek and then sets the days to Monday, Tuesday, and Saturday. -NOTE: parameter "DaysOfWeekDays" will only appear if "DaysOfWeek" has already been chosen. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFSchedule -VolumeID 9 -ScheduleName test2 -Frequency DaysOfMonth -DaysOfMonthDays 1,10,20,30 -RetentionDays 5 -RetentionHours 15 -RetentionMinutes 5 -StartingDate 2017-06-05T12:22:40 - +NOTE: parameter "DaysOfWeekDays" will only appear if "DaysOfWeek" has already been chosen. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFSchedule -VolumeID 9 -ScheduleName test2 -Frequency DaysOfMonth -DaysOfMonthDays 1,10,20,30 -RetentionDays 5 -RetentionHours 15 -RetentionMinutes 5 -StartingDate 2017-06-05T12:22:40 + Creates a new schedule named "test2" on volume 9, and sets the frequency to DaysOfMonth and then sets the days to the 1st, 10th, 20th, and 30th days in the month. Also sets starting date. NOTE: parameter "DaysOfMonthDays" will only appear if "DaysOfMonth" has already been chosen. -NOTE: you must use all three retention parameters (RetentionDays,RetentionHours,RetentionMinutes) to add a retention to the schedule or the command will error out. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - New-SFSchedule -VolumeID 10 -ScheduleName test3 -Frequency TimeInterval -TimeIntervalHours 5 -TimeIntervalMinutes 30 -SnapshotName snapTest - +NOTE: you must use all three retention parameters (RetentionDays,RetentionHours,RetentionMinutes) to add a retention to the schedule or the command will error out. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFSchedule -VolumeID 10 -ScheduleName test3 -Frequency TimeInterval -TimeIntervalHours 5 -TimeIntervalMinutes 30 -SnapshotName snapTest + Creates a new schedule named "test3" on volume 10, and sets the frequency to TimeInterval and then sets the time interval to five and a half hours. Also sets name of new Snapshot. -NOTE: parameters "TimeIntervalDays","TimeIntervalHours", and "TimeIntervalMinutes" will only appear if "TimeInterval" has already been chosen. - - - - - - - New-SFSnapshot - - [Cluster] Creates a point-in-time snapshot of a volume. - - - - - New - SFSnapshot - - - - [Cluster] Creates a point-in-time snapshot of a volume. - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - EnableRemoteReplication - - Should the snapshot be replicated to remote storage? - - - switch - - - - - - Name - - Name for the snapshot - - string - - string - - - - - - Retention - - The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - Unique ID of a snapshot from which the new snapshot is made - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - Volume - - Volume objects from which to copy - - Volume - - Volume - - - - - - VolumeID - - Unique ID of the volume image from which to copy - - long - - long - - - - - - - - - System.Int64 -SolidFire.Element.Api.Volume -System.Collections.Hashtable - - - - - [Cluster] Creates a point-in-time snapshot of a volume. - - - - - - - - - - Snapshot - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFSnapshot -VolumeID 29 - - Creates a new snapshot of volume ID 29. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFSnapshot -VolumeID 29 -Name VolSnap - - Creates a new snapshot of volume ID 29 and names the snapshot "VolSnap". - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - New-SFSnapshot -VolumeID 29 -Name VolSnap -SnapshotID 27 - - Creates a new snapshot of volume ID 29 but uses snapshot ID 27 as the source instead of the active volume and names the snapshot "VolSnap". - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - - Get-SFVolume -Name "VM*" | New-SFSnapshot -Name PowerShellSnap - - Creates a new snapshot named "PowerShellSnap" for all volumes on the cluster with names that begin with "VM". - - - - -------------------------- EXAMPLE 5 -------------------------- - - PS C:\> - - New-SFSnapshot -VolumeID 4 -Name testSnap -Retention 50:00:00 -EnableRemoteReplication:$true - - Creates a new snapshot named "testSnap" using volume ID 4. The snapshot is set to be retained for 50 hours and remote replication is enabled. - - - - - - - New-SFStorageContainer - - Creates a new storage container. - - - - - New - SFStorageContainer - - - - Creates a new storage container. - - - - InitiatorSecret - - The secret for CHAP authentication for the initiator - - string - - string - - - - - - Name - - Name of the storage container. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - TargetSecret - - The secret for CHAP authentication for the target - - string - - string - - - - - - - - - None - - - - - Creates a new storage container. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFStorageContainer -name container - - Creates a new SFStorageContainer named "container" with auto generated InitiatorSecret and TargetSecret. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFStorageContainer -Name container2 -InitiatorSecret abcd1234efgh567 -TargetSecret wxyz1234mnop567 - - Creates a new SFStorageContainer with a specified name, InitiatorSecret, and TargetSecret. - - - - - - - New-SFVirtualNetwork - - [Cluster] Adds a new virtual network to a cluster configuration. - - - - - New - SFVirtualNetwork - - - - [Cluster] Adds a new virtual network to a cluster configuration. - - - - AddressBlocks - - Unique Range of IP addresses to include in the virtual network. List of AddressBlock objects with 'start' and 'size' for the starting IP address range and size of addresses in block. - - AddressBlock[] - - AddressBlock[] - - - - - - Attributes - - List of Name/Value pairs in JSON object format. - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - Name - - User defined name for the new virtual network. - - string - - string - - - - - - Netmask - - Unique netmask for the virtual network being created. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Svip - - Unique storage IP address for the virtual network being created. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualNetworkTag - - A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported). - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String -SolidFire.Element.Api.AddressBlock[] - - - - - [Cluster] Adds a new virtual network to a cluster configuration. - - - - - - - The new VirtualNetwork object. - - - VirtualNetwork - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFVirtualNetwork -VirtualNetworkTag 2113 -Name VLAN2113 -AddressBlocks @(@{"start"="10.10.10.1";"size"=10}) -Netmask "255.255.255.0" -Svip "10.10.10.254" - - Add a new virtual network with a single block of IP addresses. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFVirtualNetwork -VirtualNetworkTag 2113 -Name VLAN2113 -AddressBlocks @(@{"start"="10.10.10.1";"size"=10};@{"start"="10.10.10.101";"size"=5}) -Netmask "255.255.255.0" -Svip "10.10.10.254" -Attributes @{"Description"="VLAN2113"} - - Add a new virtual network with two blocks of IP addresses and a description in the attributes. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - +NOTE: parameters "TimeIntervalDays","TimeIntervalHours", and "TimeIntervalMinutes" will only appear if "TimeInterval" has already been chosen. + + + + + + + New-SFSnapMirrorEndpoint + + [Cluster] New-SFSnapMirrorEndpoint creates a relationship with a remote SnapMirror endpoint. + + + + + New + SFSnapMirrorEndpoint + + + + [Cluster] New-SFSnapMirrorEndpoint creates a relationship with a remote SnapMirror endpoint. + + + + New-SFSnapMirrorEndpoint + + ManagementIP + + The management IP address of the remote SnapMirror endpoint. + + string + + + + Username + + The management username for the ONTAP system. + + string + + + + Password + + The management password for the ONTAP system. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ManagementIP + + The management IP address of the remote SnapMirror endpoint. + + string + + string + + + + + Password + + The management password for the ONTAP system. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + The management username for the ONTAP system. + + string + + string + + + + + + + + None + + + + + + + + + + + + + CreateSnapMirrorEndpointResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapMirrorEndpointResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFSnapMirrorEndpoint -managementIP 10.171.59.42 -username admin -password admin + + Creates a single endpoint to the given IP. + + + + + + + New-SFSnapMirrorEndpointUnmanaged + + [Cluster] New-SFSnapMirrorEndpointUnmanaged creates an unmanaged relationship with a remote SnapMirror endpoint. + + + + + New + SFSnapMirrorEndpointUnmanaged + + + + [Cluster] The New-SFSnapMirrorEndpointUnmanaged cmdlet enables remote, unmanaged SnapMirror endpoints to communicate with a SolidFire cluster. Unmanaged endpoints cannot be administered using the SolidFire SnapMirror APIs. They must be managed with ONTAP management software or APIs. + + + + New-SFSnapMirrorEndpointUnmanaged + + ClusterName + + The name of the endpoint. + + string + + + + IpAddresses + + The new list of IP addresses for a cluster of ONTAP storage systems that should communicate with this SolidFire cluster. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ClusterName + + The name of the endpoint. + + string + + string + + + + + IpAddresses + + The new list of IP addresses for a cluster of ONTAP storage systems that should communicate with this SolidFire cluster. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + CreateSnapMirrorEndpointUnmanagedResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapMirrorEndpointUnmanagedResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFSnapMirrorEndpointUnmanaged -ClusterName "TestCluster" -IpAddresses "1.1.1.1", "2.2.2.2", "3.3.3.3" + + Creates a new Unmanaged endpoint named "TestCluster" with 3 (fake) IP addresses associated with it. + + + + + + + New-SFSnapMirrorRelationship + + [Cluster] New-SFSnapMirrorRelationship creates a SnapMirror extended data protection relationship between a source and destination endpoint. + + + + + New + SFSnapMirrorRelationship + + + + [Cluster] New-SFSnapMirrorRelationship creates a SnapMirror extended data protection relationship between a source and destination endpoint. + + + + New-SFSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + SourceVolumeType + + The source volume's type in the SnapMirror relationship. + + string + + + + RelationshipType + + The type of relationship. On SolidFire systems, this value is always "extended_data_protection". + + string + + + + PolicyName + + Specifies the name of the ONTAP SnapMirror policy for the relationship. If not specified, the default policy name is MirrorLatest. + + string + + + + ScheduleName + + The name of the preexisting cron schedule on the ONTAP system that is used to update the SnapMirror relationship. If no schedule is designated, snapMirror updates are not scheduled and must be updated manually. + + string + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + SourceVolumeName + + The source volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + SourceVolumeVserver + + The source volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + SourceVolumeID + + The source volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + long + + + + + PolicyName + + Specifies the name of the ONTAP SnapMirror policy for the relationship. If not specified, the default policy name is MirrorLatest. + + string + + string + + + + + RelationshipType + + The type of relationship. On SolidFire systems, this value is always "extended_data_protection". + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + ScheduleName + + The name of the preexisting cron schedule on the ONTAP system that is used to update the SnapMirror relationship. If no schedule is designated, snapMirror updates are not scheduled and must be updated manually. + + string + + string + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + SourceVolumeID + + The source volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + SourceVolumeName + + The source volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + SourceVolumeType + + The source volume's type in the SnapMirror relationship. + + string + + string + + + + + SourceVolumeVserver + + The source volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + CreateSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapMirrorRelationshipResultt.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName -SourceVolumeType "solidfire" -SourceVolumeID $solidfireVolume.VolumeID + + Creates a new SnapMirror relationship with a solidfire volume as the source and an ontap volume as the destination. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -MaxTransferRate 0 -DestinationVolumeType "solidfire" -DestinationVolumeID $solidfireVolume.VolumeID -DestinationVolumeName $solidfireVolume.VolumeID -SourceVolumeType "ontap" -SourceVolumeName $snapMirrorVolume.Name -SourceVolumeVserver $vserverName + + Creates a new SnapMirror relationship with a solidfire volume as the destination and an ontap volume as the source with unlimited transfer rate. + + + + + + + New-SFSnapMirrorVolume + + [Cluster] New-SFSnapMirrorVolume creates a volume on the remote ONTAP system. + + + + + New + SFSnapMirrorVolume + + + + [Cluster] New-SFSnapMirrorVolume creates a volume on the remote ONTAP system. + + + + New-SFSnapMirrorVolume + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + Vserver + + The name of the Vserver. + + string + + + + Name + + The destination ONTAP volume name. + + string + + + + Aggregate + + The containing ONTAP aggregate in which to create the volume. You can use Get-SFSnapMirrorAggregates to get information about available ONTAP aggregates. + + string + + + + Size + + The size of the volume in bytes. + + long + + + + Type + + The volume type. Possible values are rw: Read-write volume, ls: Load-sharing volume, dp: Data protection volume. If no type is provided the default type is dp. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Aggregate + + The containing ONTAP aggregate in which to create the volume. You can use Get-SFSnapMirrorAggregates to get information about available ONTAP aggregates. + + string + + string + + + + + Name + + The destination ONTAP volume name. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Size + + The size of the volume in bytes. + + long + + long + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Type + + The volume type. Possible values are rw: Read-write volume, ls: Load-sharing volume, dp: Data protection volume. If no type is provided the default type is dp. + + string + + string + + + + + Vserver + + The name of the Vserver. + + string + + string + + + + + + + + None + + + + + + + + + + + + + CreateSnapMirrorVolumeResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapMirrorVolumeResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFSnapMirrorVolume -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -Vserver $vserverName -Name "mySnapMirrorVolume" -Aggregate $aggregateName -Size 100100100 + + Creates a new SnapMirrorVolume on the ontap device. Associates it with a specific vserver and aggregate. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFSnapMirrorVolume -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -Vserver $vserverName -Name "myLoadSharingVolume" -Aggregate $aggregateName -Size 100100100 -Type "ls" + + Creates a new SnapMirrorVolume on the ontap device. Associates it with a specific vserver and aggregate. + + + + + + + New-SFSnapshot + + [Cluster] Creates a point-in-time snapshot of a volume. + + + + + New + SFSnapshot + + + + [Cluster] Creates a point-in-time snapshot of a volume. + + + + New-SFSnapshot + + VolumeID + + Unique ID of the volume image from which to copy + + long + + + + SnapshotID + + Unique ID of a snapshot from which the new snapshot is made + + long + + + + Name + + Name for the snapshot + + string + + + + EnableRemoteReplication + + Should the snapshot be replicated to remote storage? + + + + + Retention + + The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 + + string + + + + Attributes + + Attributes to set + + hashtable + + + + EnsureSerialCreation + + Specify if the snapshot creation should be failed if a previous snapshot replication is in progress. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + New-SFSnapshot + + Volume + + Volume objects from which to copy + + Volume + + + + SnapshotID + + Unique ID of a snapshot from which the new snapshot is made + + long + + + + Name + + Name for the snapshot + + string + + + + EnableRemoteReplication + + Should the snapshot be replicated to remote storage? + + + + + Retention + + The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 + + string + + + + Attributes + + Attributes to set + + hashtable + + + + EnsureSerialCreation + + Specify if the snapshot creation should be failed if a previous snapshot replication is in progress. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + EnableRemoteReplication + + Should the snapshot be replicated to remote storage? + + + switch + + + + + EnsureSerialCreation + + Specify if the snapshot creation should be failed if a previous snapshot replication is in progress. + + + switch + + + + + Name + + Name for the snapshot + + string + + string + + + + + Retention + + The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00 + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + Unique ID of a snapshot from which the new snapshot is made + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Volume + + Volume objects from which to copy + + Volume + + Volume + + + + + VolumeID + + Unique ID of the volume image from which to copy + + long + + long + + + + + + + + System.Int64 +SolidFire.Element.Api.Volume +System.Collections.Hashtable + + + + + + + + + + + + + Snapshot + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFSnapshot -VolumeID 29 + + Creates a new snapshot of volume ID 29. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFSnapshot -VolumeID 29 -Name VolSnap + + Creates a new snapshot of volume ID 29 and names the snapshot "VolSnap". + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + New-SFSnapshot -VolumeID 29 -Name VolSnap -SnapshotID 27 + + Creates a new snapshot of volume ID 29 but uses snapshot ID 27 as the source instead of the active volume and names the snapshot "VolSnap". + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VM*" | New-SFSnapshot -Name PowerShellSnap + + Creates a new snapshot named "PowerShellSnap" for all volumes on the cluster with names that begin with "VM". + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + New-SFSnapshot -VolumeID 4 -Name testSnap -Retention 50:00:00 -EnableRemoteReplication:$true + + Creates a new snapshot named "testSnap" using volume ID 4. The snapshot is set to be retained for 50 hours and remote replication is enabled. + + + + + + + New-SFStorageContainer + + Creates a new storage container. + + + + + New + SFStorageContainer + + + + Creates a new storage container. + + + + New-SFStorageContainer + + Name + + Name of the storage container. + + string + + + + InitiatorSecret + + The secret for CHAP authentication for the initiator + + string + + + + TargetSecret + + The secret for CHAP authentication for the target + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + InitiatorSecret + + The secret for CHAP authentication for the initiator + + string + + string + + + + + Name + + Name of the storage container. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TargetSecret + + The secret for CHAP authentication for the target + + string + + string + + + + + + + + None + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFStorageContainer -name container + + Creates a new SFStorageContainer named "container" with auto generated InitiatorSecret and TargetSecret. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFStorageContainer -Name container2 -InitiatorSecret abcd1234efgh567 -TargetSecret wxyz1234mnop567 + + Creates a new SFStorageContainer with a specified name, InitiatorSecret, and TargetSecret. + + + + + + + New-SFVirtualNetwork + + [Cluster] Adds a new virtual network to a cluster configuration. + + + + + New + SFVirtualNetwork + + + + [Cluster] Adds a new virtual network to a cluster configuration. + + + + New-SFVirtualNetwork + + VirtualNetworkTag + + A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported). + + long + + + + Name + + User defined name for the new virtual network. + + string + + + + AddressBlocks + + Unique Range of IP addresses to include in the virtual network. List of AddressBlock objects with 'start' and 'size' for the starting IP address range and size of addresses in block. + + AddressBlock[] + + + + Netmask + + Unique netmask for the virtual network being created. + + string + + + + Svip + + Unique storage IP address for the virtual network being created. + + string + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AddressBlocks + + Unique Range of IP addresses to include in the virtual network. List of AddressBlock objects with 'start' and 'size' for the starting IP address range and size of addresses in block. + + AddressBlock[] + + AddressBlock[] + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + Name + + User defined name for the new virtual network. + + string + + string + + + + + Netmask + + Unique netmask for the virtual network being created. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Svip + + Unique storage IP address for the virtual network being created. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualNetworkTag + + A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported). + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +SolidFire.Element.Api.AddressBlock[] + + + + + + + + + + The new VirtualNetwork object. + + + VirtualNetwork + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFVirtualNetwork -VirtualNetworkTag 2113 -Name VLAN2113 -AddressBlocks @(@{"start"="10.10.10.1";"size"=10}) -Netmask "255.255.255.0" -Svip "10.10.10.254" + + Add a new virtual network with a single block of IP addresses. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFVirtualNetwork -VirtualNetworkTag 2113 -Name VLAN2113 -AddressBlocks @(@{"start"="10.10.10.1";"size"=10};@{"start"="10.10.10.101";"size"=5}) -Netmask "255.255.255.0" -Svip "10.10.10.254" -Attributes @{"Description"="VLAN2113"} + + Add a new virtual network with two blocks of IP addresses and a description in the attributes. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + $blocks = @() $block = @{} $block.Add("start", "123.45.45.0") $block.Add("size", 10) $blocks += $block -New-SFVirtualNetwork -VirtualNetworkTag 10 -Name "VLAN10-Finance" -AddressBlocks $blocks -Netmask "255.255.255.0" -Svip "123.45.45.25" - - Add a new virtual network with a single block of IP addresses. - - - - - - - New-SFVolume - - [Cluster] Creates a new SolidFire volume. - - - - - New - SFVolume - - - - [Cluster] Creates a new SolidFire volume. - - - - Account - - Account Information for the owner of this volume - - Account - - Account - - - - - - AccountID - - Account ID for the owner of this volume - - long - - long - - - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - BurstIOPS - - The maximum 4KB IOPS allowed for a short time - - int - - int - - - - - - Enable512e - - The volume provides 512-byte sector emulation - - bool - - bool - - - - - - GB - - Switch used to interpret total size as GB - - - switch - - - - - - GiB - - Switch used to interpret total size as GiB - - - switch - - - - - - MaxIOPS - - The desired maximum 4KB IOPS to guarantee - - int - - int - - - - - - MinIOPS - - The desired minimum 4KB IOPS to guarantee - - int - - int - - - - - - Name - - Name of the volume access group - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - TotalSize - - Total size of the volume in GB - - long - - long - - - - - - - - - System.String -System.Int64 -SolidFire.Element.Api.Account -System.Int32 - - - - - [Cluster] Creates a new SolidFire volume. - - - - - - - - - - Volume - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFVolume -Name NewVol01 -AccountID 3 -Enable512e:$true -TotalSize 100 -GB - - Creates a new volume with the name "NewVol01" associated with account ID 3. 512 Byte emulation will be enabled and the total size will be 100 GB. Note that the -GB and -GiB switch parameters are optional. If neither is supplied the -TotalSize parameter must be entered in Bytes. Since Min, Max and Burst IOPS have been omitted, this volume will receive the cluster defaults. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFVolume -Name NewVol01 -AccountID 3 -Enable512e:$true -TotalSize 100 -GB -MinIOPS 100 -MaxIOPS 500 -BurstIOPS 1000 - - Creates a new volume with the name "NewVol01" associated with account ID 3. 512 Byte emulation will be enabled and the total size will be 100 GB. For this volume the QoS settings will be 100:500:1000, MinIOPS:MaxIOPS:BurstIOPS. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - For ($i = 1; $i -le 10; $i++) {New-SFVolume -Name NewVol$i -AccountID 3 -TotalSize 100 -GB -Enable512e:$true -MinIOPS 100 -MaxIOPS 500 -BurstIOPS 1000} - - Create 10x 100GB volumes named sequentially from NewVol1 to NewVol10 associated with account ID 3. Each volume will have QoS settings of 100:500:1000, MinIOPS:MaxIOPS:BurstIOPS and 512 Byte emulation will be enabled. - - - - - - - New-SFVolumeAccessGroup - - [Cluster] Creates a new volume access group. - - - - - New - SFVolumeAccessGroup - - - - [Cluster] Creates a new volume access group. - - - - Attributes - - Hashtable of name/values - - hashtable - - hashtable - - - - - - Initiators - - List of initiator names (IQNs and WWPNs) to include in the volume access group - - string[] - - string[] - - - - - - Name - - Name of the volume access group - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualNetworkID - - The ID of the SolidFire Virtual Network ID to associate the volume access group with. - - long[] - - long[] - - - - - - VirtualNetworkTag - - The ID of the VLAN Virtual Network Tag to associate the volume access group with. - - long[] - - long[] - - - - - - VolumeIDs - - List of VolumeIDs to include in the volume access group - - long[] - - long[] - - - - - - - - - System.String -System.String[] -System.Int64[] -System.Collections.Hashtable - - - - - [Cluster] Creates a new volume access group. - - - - - - - - - - VolumeAccessGroup - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - New-SFVolumeAccessGroup -Name VMwareHosts - +New-SFVirtualNetwork -VirtualNetworkTag 10 -Name "VLAN10-Finance" -AddressBlocks $blocks -Netmask "255.255.255.0" -Svip "123.45.45.25" + + Add a new virtual network with a single block of IP addresses. + + + + + + + New-SFVolume + + [Cluster] Creates a new SolidFire volume. + + + + + New + SFVolume + + + + [Cluster] Creates a new SolidFire volume. + + + + New-SFVolume + + Name + + Name of the volume access group. Length is of 1 to 64 characters. + + string + + + + AccountID + + Account ID for the owner of this volume + + long + + + + Account + + Account Information for the owner of this volume + + Account + + + + Enable512e + + The volume provides 512-byte sector emulation + + bool + + + + TotalSize + + Total size of the volume in GB + + long + + + + GB + + Switch used to interpret total size as GB + + + + + GiB + + Switch used to interpret total size as GiB + + + + + Attributes + + Attributes to set + + hashtable + + + + QoSPolicyID + + The ID for the policy whose QoS settings should be applied to the specified volumes. + + int + + + + AssociateWithQoSPolicy + + Associate the volume with the specified QoSPolicyID. + + bool + + + + TotalSizeInDecimal + + Total size of the volume in decimal. Can only be used when GB and GiB switches are present. + + double + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + + + ProtectionScheme + + Protection scheme that should be used for this volume. The default value is the defaultProtectionScheme stored in the ClusterInfo object. + + string + + + + EnableSnapMirrorReplication + + Specifies whether SnapMirror replication is enabled or not. + + + + + Access + + The access mode for the volume. + + string + + + + FifoSize + + Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. + + long + + + + MinFifoSize + + Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + New-SFVolume + + Name + + Name of the volume access group. Length is of 1 to 64 characters. + + string + + + + AccountID + + Account ID for the owner of this volume + + long + + + + Account + + Account Information for the owner of this volume + + Account + + + + Enable512e + + The volume provides 512-byte sector emulation + + bool + + + + TotalSize + + Total size of the volume in GB + + long + + + + GB + + Switch used to interpret total size as GB + + + + + GiB + + Switch used to interpret total size as GiB + + + + + Attributes + + Attributes to set + + hashtable + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + + + TotalSizeInDecimal + + Total size of the volume in decimal. Can only be used when GB and GiB switches are present. + + double + + + + QoSPolicyID + + The ID for the policy whose QoS settings should be applied to the specified volumes. + + int + + + + AssociateWithQoSPolicy + + Associate the volume with the specified QoSPolicyID. + + bool + + + + ProtectionScheme + + Protection scheme that should be used for this volume. The default value is the defaultProtectionScheme stored in the ClusterInfo object. + + string + + + + EnableSnapMirrorReplication + + Specifies whether SnapMirror replication is enabled or not. + + + + + Access + + The access mode for the volume. + + string + + + + FifoSize + + Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. + + long + + + + MinFifoSize + + Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Access + + The access mode for the volume. + + string + + string + + + + + Account + + Account Information for the owner of this volume + + Account + + Account + + + + + AccountID + + Account ID for the owner of this volume + + long + + long + + + + + AssociateWithQoSPolicy + + Associate the volume with the specified QoSPolicyID. + + bool + + bool + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + int + + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + int + + + + + Enable512e + + The volume provides 512-byte sector emulation + + bool + + bool + + + + + EnableSnapMirrorReplication + + Specifies whether SnapMirror replication is enabled or not. + + + switch + + + + + FifoSize + + Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. + + long + + long + + + + + GB + + Switch used to interpret total size as GB + + + switch + + + + + GiB + + Switch used to interpret total size as GiB + + + switch + + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + int + + + + + MinFifoSize + + Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. + + long + + long + + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + int + + + + + Name + + Name of the volume access group. Length is of 1 to 64 characters. + + string + + string + + + + + ProtectionScheme + + Protection scheme that should be used for this volume. The default value is the defaultProtectionScheme stored in the ClusterInfo object. + + string + + string + + + + + QoSPolicyID + + The ID for the policy whose QoS settings should be applied to the specified volumes. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TotalSize + + Total size of the volume in GB + + long + + long + + + + + TotalSizeInDecimal + + Total size of the volume in decimal. Can only be used when GB and GiB switches are present. + + double + + double + + + + + + + + System.String +System.Int64 +SolidFire.Element.Api.Account +System.Management.Automation.SwitchParameter +System.Nullable`1[[System.Int64, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + + + + + + + + + + + + + Volume + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFVolume -Name NewVol01 -AccountID 3 -Enable512e:$true -TotalSize 100 -GB + + Creates a new volume with the name "NewVol01" associated with account ID 3. 512 Byte emulation will be enabled and the total size will be 100 GB. Note that the -GB and -GiB switch parameters are optional. If neither is supplied the -TotalSize parameter must be entered in Bytes. Since Min, Max and Burst IOPS have been omitted, this volume will receive the cluster defaults. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFVolume -Name NewVol01 -AccountID 3 -Enable512e:$true -TotalSize 100 -GB -MinIOPS 100 -MaxIOPS 500 -BurstIOPS 1000 + + Creates a new volume with the name "NewVol01" associated with account ID 3. 512 Byte emulation will be enabled and the total size will be 100 GB. For this volume the QoS settings will be 100:500:1000, MinIOPS:MaxIOPS:BurstIOPS. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + For ($i = 1; $i -le 10; $i++) {New-SFVolume -Name NewVol$i -AccountID 3 -TotalSize 100 -GB -Enable512e:$true -MinIOPS 100 -MaxIOPS 500 -BurstIOPS 1000} + + Create 10x 100GB volumes named sequentially from NewVol1 to NewVol10 associated with account ID 3. Each volume will have QoS settings of 100:500:1000, MinIOPS:MaxIOPS:BurstIOPS and 512 Byte emulation will be enabled. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + New-SFVolume -Name "Temp" -QoSPolicyID 777 -AssociateWithQoSPolicy:$true + + Creates a new volume named "Temp" using QoSPolicy with ID 777 and associates the volume with the QoS policy so that the volume will inherit any future changes to the policy. + + + + + + + New-SFVolumeAccessGroup + + [Cluster] Creates a new volume access group. + + + + + New + SFVolumeAccessGroup + + + + [Cluster] Creates a new volume access group. + + + + New-SFVolumeAccessGroup + + Name + + Name of the volume access group + + string + + + + Initiators + + List of initiator names (IQNs and WWPNs) to include in the volume access group + + string[] + + + + VolumeIDs + + List of VolumeIDs to include in the volume access group + + long[] + + + + Attributes + + Hashtable of name/values + + hashtable + + + + VirtualNetworkID + + + + long[] + + + + VirtualNetworkTag + + The ID of the VLAN Virtual Network Tag to associate the volume access group with. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Attributes + + Hashtable of name/values + + hashtable + + hashtable + + + + + Initiators + + List of initiator names (IQNs and WWPNs) to include in the volume access group + + string[] + + string[] + + + + + Name + + Name of the volume access group + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualNetworkID + + The ID of the SolidFire Virtual Network ID to associate the volume access group with. + + long[] + + long[] + + + + + VirtualNetworkTag + + The ID of the VLAN Virtual Network Tag to associate the volume access group with. + + long[] + + long[] + + + + + VolumeIDs + + List of VolumeIDs to include in the volume access group + + long[] + + long[] + + + + + + + + System.String +System.String[] +System.Int64[] +System.Collections.Hashtable + + + + + + + + + + + + + VolumeAccessGroup + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + New-SFVolumeAccessGroup -Name VMwareHosts + Creates a new volume access group with the name "VMwareHosts". -Note that this volume access group contains no volumes or initiators at this point. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - New-SFVolumeAccessGroup -Name VMwareHosts -Initiators "iqn.1994-05.com.redhat:8afd1bec9877" -VolumeIDs 13,14,15 - - Creates a new volume access group with the name "VMwareHosts", adds one inititator and three volumes. - - - - - - - Remove-SFAccount - - [Cluster] Removes an existing account. - - - - - Remove - SFAccount - - - - [Cluster] Removes an existing account. - - - - Account - - Enter an account ID - - Account[] - - Account[] - - - - - - AccountID - - Enter an account ID - - long[] - - long[] - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -SolidFire.Element.Api.Account[] - - - - - [Cluster] Removes an existing account. - - - - - - - Remove-SFAccount is used to remove an existing account. All Volumes must be deleted and purged on the account before it can be removed. If volumes on the account are still pending deletion, Remove-SFAccount cannot be used Remove-SFVolume to delete and purge the volumes. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFAccount -AccountID 4 - - Removes account with AccountID 4. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Remove-SFAccount -Account (Get-SFAccount Account1) - - Removes the account(s) provided in the account object. - - - - - - - Remove-SFClusterAdmin - - [Cluster] Removes a cluster admin. - - - - - Remove - SFClusterAdmin - - - - [Cluster] Removes a cluster admin. - - - - ClusterAdmin - - ClusterAdmin for the Cluster Admin to remove. - - ClusterAdmin[] - - ClusterAdmin[] - - - - - - ClusterAdminID - - ClusterAdminID for the Cluster Admin to remove. - - long[] - - long[] - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Username - - Name the Cluster Admin to remove. Must be exact match. Case sensitive. - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -System.String[] -SolidFire.Element.Api.ClusterAdmin[] - - - - - [Cluster] Removes a cluster admin. - - - - - - - - - - ClusterAdmin[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFClusterAdmin -ClusterAdminID 5 - - Removes cluster admin with ID 5. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Remove-SFClusterAdmin -Username "StorageAdmin" - - Removes a cluster admin user with the username of "StorageAdmin". - - - - - - - Remove-SFClusterFault - - [Cluster] Removes faults on the cluster. - - - - - Remove - SFClusterFault - - - - [Cluster] Removes faults on the cluster. - - - - Confirm - - - - - switch - - - - - - FaultType - - Specify the fault type to be removed. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String - - - - - [Cluster] Removes faults on the cluster. - - - - - - - - - - ClearClusterFaultsResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClearClusterFaultsResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFClusterFault - - Remove all cluster faults. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Remove-SFClusterFault -FaultType current - - Remove any current active cluster faults. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Remove-SFClusterFault -FaultType resolved - - Remove any past resolved cluster faults from the fault log. - - - - - - - Remove-SFClusterPair - - [Cluster] Disconnects the open connections between two clusters created by cluster pairing. - - - - - Remove - SFClusterPair - - - - [Cluster] Disconnects the open connections between two clusters created by cluster pairing. - - - - ClusterPairID - - Unique identifier used to pair two clusters. - - long - - long - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 - - - - - [Cluster] Disconnects the open connections between two clusters created by cluster pairing. - - - - - - - - - - RemoveClusterPairResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RemoveClusterPairResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFClusterPair -ClusterPairID 7 -Confirm:$false - - Removes specified ClusterPair without a confirmation prompt. - - - - - - - Remove-SFDeletedVolume - - [Cluster] Immediately and permanently purges a volume that has been deleted. - - - - - Remove - SFDeletedVolume - - - - [Cluster] Immediately and permanently purges a volume that has been deleted. - - - - AccountID - - A list of accountIDs. All of the volumes from all of the specified accounts are purged from the system. Note well: you cannot use this parameter unless all the volumes in a given account have been deleted. - - long[] - - long[] - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - A list of volumeAccessGroupIDs. All of the volumes from all of the specified Volume Access Groups are purged from the system. Note well: you cannot use this parameter unless all the volumes in the given VAG have been deleted. - - long[] - - long[] - - - - - - VolumeID - - Array of VolumeIDs to be purged. - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Immediately and permanently purges a volume that has been deleted. - - - - - - - Remove-SFDeletedVolume immediately and permanently purges a volume which has been deleted. A volume must be deleted using Delete-SFVolume before it can be purged. Volumes are purged automatically after a period of time, so usage of this method is not typically required. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFDeletedVolume -VolumeID 5 - - Purges volume ID 5. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFDeletedVolume -Name "VM*" | Remove-SFDeletedVolume - - Remove all deleted volumes with names beginning with "VM". - - - - - - - Remove-SFDrive - - [Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal. - - - - - Remove - SFDrive - - - - [Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal. - - - - Confirm - - - - - switch - - - - - - Drive - - Please pass in a SFDrive or list of SFDrives - - DriveInfo[] - - DriveInfo[] - - - - - - DriveID - - Enter a drive ID or list of drive IDs - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -SolidFire.Element.Api.DriveInfo[] - - - - - [Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal. - - - - - - - - - - AsyncHandleResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AsyncHandleResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFDrive -DriveID 19 - - Removes drive ID 19. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Note that this volume access group contains no volumes or initiators at this point. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + New-SFVolumeAccessGroup -Name VMwareHosts -Initiators "iqn.1994-05.com.redhat:8afd1bec9877" -VolumeIDs 13,14,15 + + Creates a new volume access group with the name "VMwareHosts", adds one inititator and three volumes. + + + + + + + Remove-SFAccount + + [Cluster] Removes an existing account. + + + + + Remove + SFAccount + + + + [Cluster] Removes an existing account. + + + + Remove-SFAccount + + AccountID + + Enter an account ID + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFAccount + + Account + + Enter an account ID + + Account[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Account + + Enter an account ID + + Account[] + + Account[] + + + + + AccountID + + Enter an account ID + + long[] + + long[] + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +SolidFire.Element.Api.Account[] + + + + + + + + + + Remove-SFAccount is used to remove an existing account. All Volumes must be deleted and purged on the account before it can be removed. If volumes on the account are still pending deletion, Remove-SFAccount cannot be used Remove-SFVolume to delete and purge the volumes. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFAccount -AccountID 4 + + Removes account with AccountID 4. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFAccount -Account (Get-SFAccount Account1) + + Removes the account(s) provided in the account object. + + + + + + + Remove-SFAuthSession + + [Cluster] Deletes an individual auth session + + + + + Remove + SFAuthSession + + + + [Cluster] Deletes an individual auth session. + + + + Remove-SFAuthSession + + SessionID + + UUID for the auth session to be deleted. + + guid + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFAuthSession + + ClusterAdminID + + ID that identifies a clusterAdmin. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFAuthSession + + Username + + Name that uniquely identifies the user. + + string + + + + AuthMethod + + Authentication method of the user sessions to be deleted. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AuthMethod + + Authentication method of the user sessions to be deleted. + + string + + string + + + + + ClusterAdminID + + ID that identifies a clusterAdmin. + + long + + long + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SessionID + + UUID for the auth session to be deleted. + + guid + + guid + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + Name that uniquely identifies the user. + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.Guid +System.Int64 +System.String + + + + + + + + + + + + + AuthSesssionInfo[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFAuthSession -SessionId c2179057-e7ef-4ea6-95d3-8347a623d8ef + + Deletes the auth session by SessionId c2179057-e7ef-4ea6-95d3-8347a623d8ef + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFAuthSession -ClusterAdminID 1 + + Deletes the auth session by ClusterAdminID 1 + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Remove-SFAuthSession -Username admin -AuthMethod Cluster + + Deletes the auth session by Username admin and AuthMethod Cluster + + + + + + + Remove-SFClusterAdmin + + [Cluster] Removes a cluster admin. + + + + + Remove + SFClusterAdmin + + + + [Cluster] Removes a cluster admin. + + + + Remove-SFClusterAdmin + + ClusterAdminID + + ClusterAdminID for the Cluster Admin to remove. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFClusterAdmin + + Username + + Name the Cluster Admin to remove. Must be exact match. Case sensitive. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFClusterAdmin + + ClusterAdmin + + ClusterAdmin for the Cluster Admin to remove. + + ClusterAdmin[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + ClusterAdmin + + ClusterAdmin for the Cluster Admin to remove. + + ClusterAdmin[] + + ClusterAdmin[] + + + + + ClusterAdminID + + ClusterAdminID for the Cluster Admin to remove. + + long[] + + long[] + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + Name the Cluster Admin to remove. Must be exact match. Case sensitive. + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +System.String[] +SolidFire.Element.Api.ClusterAdmin[] + + + + + + + + + + + + + ClusterAdmin[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFClusterAdmin -ClusterAdminID 5 + + Removes cluster admin with ID 5. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFClusterAdmin -Username "StorageAdmin" + + Removes a cluster admin user with the username of "StorageAdmin". + + + + + + + Remove-SFClusterFault + + [Cluster] Removes faults on the cluster. + + + + + Remove + SFClusterFault + + + + [Cluster] Removes faults on the cluster. + + + + Remove-SFClusterFault + + FaultType + + Specify the fault type to be removed. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + FaultType + + Specify the fault type to be removed. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String + + + + + + + + + + + + + ClearClusterFaultsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClearClusterFaultsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFClusterFault + + Remove all cluster faults. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFClusterFault -FaultType current + + Remove any current active cluster faults. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Remove-SFClusterFault -FaultType resolved + + Remove any past resolved cluster faults from the fault log. + + + + + + + Remove-SFClusterInterfacePreference + + [Cluster] Deletes an existing cluster interface preference. + + + + + Remove + SFClusterInterfacePreference + + + + [Cluster] Lets you remove a value to the key-value store. Works similar to a dictionary. Requires confirmation. + + + + Remove-SFClusterInterfacePreference + + Name + + Name of the key you want to delete. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Name + + Name of the key you want to delete. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DeleteClusterInterfacePreferenceResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DeleteClusterInterfacePreferenceResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFClusterInterfacePreference -Name "bugs" -Confirm:$false + + Removes an entry from the key-value store. + + + + + + + Remove-SFClusterPair + + [Cluster] Disconnects the open connections between two clusters created by cluster pairing. + + + + + Remove + SFClusterPair + + + + [Cluster] Disconnects the open connections between two clusters created by cluster pairing. + + + + Remove-SFClusterPair + + ClusterPairID + + Unique identifier used to pair two clusters. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + ClusterPairID + + Unique identifier used to pair two clusters. + + long + + long + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 + + + + + + + + + + + + + RemoveClusterPairResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RemoveClusterPairResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFClusterPair -ClusterPairID 7 -Confirm:$false + + Removes specified ClusterPair without a confirmation prompt. + + + + + + + Remove-SFDeletedVolume + + [Cluster] Immediately and permanently purges a volume that has been deleted. + + + + + Remove + SFDeletedVolume + + + + [Cluster] Immediately and permanently purges a volume that has been deleted. + + + + Remove-SFDeletedVolume + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFDeletedVolume + + VolumeID + + Array of VolumeIDs to be purged. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFDeletedVolume + + AccountID + + A list of accountIDs. All of the volumes from all of the specified accounts are purged from the system. Note well: you cannot use this parameter unless all the volumes in a given account have been deleted. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFDeletedVolume + + VolumeAccessGroupID + + A list of volumeAccessGroupIDs. All of the volumes from all of the specified Volume Access Groups are purged from the system. Note well: you cannot use this parameter unless all the volumes in the given VAG have been deleted. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AccountID + + A list of accountIDs. All of the volumes from all of the specified accounts are purged from the system. Note well: you cannot use this parameter unless all the volumes in a given account have been deleted. + + long[] + + long[] + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + A list of volumeAccessGroupIDs. All of the volumes from all of the specified Volume Access Groups are purged from the system. Note well: you cannot use this parameter unless all the volumes in the given VAG have been deleted. + + long[] + + long[] + + + + + VolumeID + + Array of VolumeIDs to be purged. + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + Remove-SFDeletedVolume immediately and permanently purges a volume which has been deleted. A volume must be deleted using Delete-SFVolume before it can be purged. Volumes are purged automatically after a period of time, so usage of this method is not typically required. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFDeletedVolume -VolumeID 5 + + Purges volume ID 5. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFDeletedVolume -Name "VM*" | Remove-SFDeletedVolume + + Remove all deleted volumes with names beginning with "VM". + + + + + + + Remove-SFDrive + + [Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal. + + + + + Remove + SFDrive + + + + [Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal. + + + + Remove-SFDrive + + DriveID + + Enter a drive ID or list of drive IDs + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFDrive + + Drive + + Please pass in a SFDrive or list of SFDrives + + DriveInfo[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Drive + + Please pass in a SFDrive or list of SFDrives + + DriveInfo[] + + DriveInfo[] + + + + + DriveID + + Enter a drive ID or list of drive IDs + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +SolidFire.Element.Api.DriveInfo[] + + + + + + + + + + + + + AsyncHandleResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AsyncHandleResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFDrive -DriveID 19 + + Removes drive ID 19. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $drives = Get-SFDrive -Remove-SFDrive -Drive $drives[3] - - Gets all the drives and passes a selected drive for removal. - - - - - - - Remove-SFGroupSnapshot - - [Cluster] Removes a group snapshot and optionally preserves the individual snapshots. - - - - - Remove - SFGroupSnapshot - - - - [Cluster] Removes a group snapshot and optionally preserves the individual snapshots. - - - - Confirm - - - - - switch - - - - - - GroupSnapshotID - - Group snapshot ID(s) to remove - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SaveMembers - - Save the individual snapshots for the specified group snapshot ID(s), Default False - Both the group and individual snapshots are removed. - - - switch - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -System.Management.Automation.SwitchParameter - - - - - [Cluster] Removes a group snapshot and optionally preserves the individual snapshots. - - - - - - - Removes a group snapshot. The saveMembers parameter can be used to preserve all the snapshots that were made for the volumes in the group, but the group association will be removed. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFGroupSnapshot -GroupSnapshotID 3 -SaveMembers - +Remove-SFDrive -Drive $drives[3] + + Gets all the drives and passes a selected drive for removal. + + + + + + + Remove-SFGroupSnapshot + + [Cluster] Removes a group snapshot and optionally preserves the individual snapshots. + + + + + Remove + SFGroupSnapshot + + + + [Cluster] Removes a group snapshot and optionally preserves the individual snapshots. + + + + Remove-SFGroupSnapshot + + GroupSnapshotID + + Group snapshot ID(s) to remove + + long[] + + + + SaveMembers + + Save the individual snapshots for the specified group snapshot ID(s), Default False - Both the group and individual snapshots are removed. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + GroupSnapshotID + + Group snapshot ID(s) to remove + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SaveMembers + + Save the individual snapshots for the specified group snapshot ID(s), Default False - Both the group and individual snapshots are removed. + + + switch + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +System.Management.Automation.SwitchParameter + + + + + + + + + + Removes a group snapshot. The saveMembers parameter can be used to preserve all the snapshots that were made for the volumes in the group, but the group association will be removed. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFGroupSnapshot -GroupSnapshotID 3 -SaveMembers + Remove the group snapshot with ID 3 but retain the individual volume snapshots that it includes. -Note: The default behavior is to remove both the group snapshot and the individual snapshots. - - - - - - - Remove-SFInitiator - - Deletes one or more initiators from the system (and from any associated volumes or volume access groups). - - - - - Remove - SFInitiator - - - +Note: The default behavior is to remove both the group snapshot and the individual snapshots. + + + + + + + Remove-SFIdpConfiguration + + [Cluster] Delete an existing configuration with a third party Identity Provider (IdP) for the cluster. + + + + + Remove + SFIdpConfiguration + + + + [Cluster] Delete an existing configuration with a third party Identity Provider (IdP) for the cluster. + + + + Remove-SFIdpConfiguration + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFIdpConfiguration + + IdpName + + Name for identifying and retrieving IdP provider for SAML 2.0 single sign-on. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + guid + + + + + IdpName + + Name for identifying and retrieving IdP provider for SAML 2.0 single sign-on. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Guid +System.String + + + + + + + + + + + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFIdpConfiguration -IdpName adfsidp + + Delete an existing IDP Configuration with IdpName adfsidp + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFIdpConfiguration -IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a + + Delete an existing IDP Configuration with IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a + + + + + + + Remove-SFInitiator + + Deletes one or more initiators from the system (and from any associated volumes or volume access groups). + + + + + Remove + SFInitiator + + + Deletes one or more initiators from the system (and from any associated volumes or volume access groups). - - If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible). - - - - Confirm - - - - - switch - - - - - - Initiator - - An array of initiators to delete. - - Initiator[] - - Initiator[] - - - - - - InitiatorID - - An array of IDs of initiators to delete. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -SolidFire.Element.Api.Initiator[] - - - - - Deletes one or more initiators from the system (and from any associated volumes or volume access groups). - - If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible). - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFInitiator -InitiatorID 1 -Confirm:$false - - Removes the initiatior ID 1 with no confirmation prompt. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFInitiator -InitiatorID 4 | Remove-SFInitiator -confirm:$false - - Gets specified initiator(s) and removes them with no confirmation prompt. - - - - - - - Remove-SFInitiatorFromVolumeAccessGroup - - [Cluster] Removes initiators from a volume access group. - - - - - Remove - SFInitiatorFromVolumeAccessGroup - - - - [Cluster] Removes initiators from a volume access group. - - - - Confirm - - - - - switch - - - - - - Initiators - - List of initiator names (IQNs and WWPNs) to remove from the volume access group - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID or list of volume access group IDs - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String[] - - - - - [Cluster] Removes initiators from a volume access group. - - - - - - - - - - VolumeAccessGroup - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFInitiatorFromVolumeAccessGroup -VolumeAccessGroupID 3 -Initiators "iqn.1994-05.com.redhat:8afd1bec9877" - - Removes this single initiator from the volume access group. - - - - - - - Remove-SFNode - - [Cluster] Removes one or more nodes from the cluster. - - - - - Remove - SFNode - - - - [Cluster] Removes one or more nodes from the cluster. - - - - Confirm - - - - - switch - - - - - - NodeID - - List of NodeIDs for the nodes to be removed. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Removes one or more nodes from the cluster. - - - - - - + + If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible). + + + + Remove-SFInitiator + + Initiator + + An array of initiators to delete. + + Initiator[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFInitiator + + InitiatorID + + An array of IDs of initiators to delete. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Initiator + + An array of initiators to delete. + + Initiator[] + + Initiator[] + + + + + InitiatorID + + An array of IDs of initiators to delete. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +SolidFire.Element.Api.Initiator[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFInitiator -InitiatorID 1 -Confirm:$false + + Removes the initiatior ID 1 with no confirmation prompt. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFInitiator -InitiatorID 4 | Remove-SFInitiator -confirm:$false + + Gets specified initiator(s) and removes them with no confirmation prompt. + + + + + + + Remove-SFInitiatorFromVolumeAccessGroup + + [Cluster] Removes initiators from a volume access group. + + + + + Remove + SFInitiatorFromVolumeAccessGroup + + + + [Cluster] Removes initiators from a volume access group. + + + + Remove-SFInitiatorFromVolumeAccessGroup + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs + + long + + + + Initiators + + List of initiator names (IQNs and WWPNs) to remove from the volume access group + + string[] + + + + DeleteOrphanInitiators + + Delete initiators if no longer associated with any volume access group. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + DeleteOrphanInitiators + + Delete initiators if no longer associated with any volume access group. + + bool + + bool + + + + + Initiators + + List of initiator names (IQNs and WWPNs) to remove from the volume access group + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String[] + + + + + + + + + + + + + VolumeAccessGroup + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFInitiatorFromVolumeAccessGroup -VolumeAccessGroupID 3 -Initiators "iqn.1994-05.com.redhat:8afd1bec9877" + + Removes this single initiator from the volume access group. + + + + + + + Remove-SFKeyProviderKmip + + [Cluster] Removes the specified inactive Key Provider. + + + + + Remove + SFKeyProviderKmip + + + + [Cluster] Removes the specified inactive Key Provider. + + + + Remove-SFKeyProviderKmip + + KeyProviderID + + The ID of the Key Provider to delete. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + KeyProviderID + + The ID of the Key Provider to delete. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DeleteKeyProviderKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFKeyProviderKmip -KeyProviderID 1 + + Removes an inactive key provider. + + + + + + + Remove-SFKeyServerFromProviderKmip + + [Cluster] Remove the specified KMIP (Key Management Interoperability Protocol) Key Server from the provider it was assigned to. + + + + + Remove + SFKeyServerFromProviderKmip + + + + [Cluster] Remove the specified KMIP (Key Management Interoperability Protocol) Key Server from the provider it was assigned to via AddKeyServerToProviderKmip. A KMIP Key Server can be unassigned from its provider unless it's the last one and that provider is active (providing keys which are currently in use). If the specified KMIP Key Server is not assigned to a provider, this is a no-op and no error will be returned. + + + + Remove-SFKeyServerFromProviderKmip + + KeyServerID + + The port number associated with this KMIP Key Server (typically 5696). + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + KeyServerID + + The port number associated with this KMIP Key Server (typically 5696). + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + CreateKeyServerKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFKeyServerKmip -KeyServerID 1 -KeyServerName "MyKeyServer" + + Set the name of Key Server with the specified ID + + + + + + + Remove-SFKeyServerKmip + + [Cluster] Removes the specified inactive Key Server. + + + + + Remove + SFKeyServerKmip + + + + [Cluster] Delete the specified KMIP (Key Management Interoperability Protocol) Key Server. A KMIP Key Server can be deleted unless it's the last one assigned to its provider, and that provider is active (providing keys which are currently in use). + + + + Remove-SFKeyServerKmip + + KeyServerID + + The ID of the Key Server to delete. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + KeyServerID + + The ID of the Key Server to delete. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + DeleteKeyServerKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFKeyServerKmip -KeyServerID 1 + + Removes an inactive key server. + + + + + + + Remove-SFNode + + [Cluster] Removes one or more nodes from the cluster. + + + + + Remove + SFNode + + + + [Cluster] Removes one or more nodes from the cluster. + + + + Remove-SFNode + + NodeID + + List of NodeIDs for the nodes to be removed. + + long[] + + + + IgnoreEnsembleToleranceChange + + Ignore changes to the ensemble's node failure tolerance when removing nodes. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + IgnoreEnsembleToleranceChange + + Ignore changes to the ensemble's node failure tolerance when removing nodes. + + + switch + + + + + NodeID + + List of NodeIDs for the nodes to be removed. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + Used to remove one or more nodes that should no longer participate in the cluster. Before removing a node, all drives it contains must first be removed with Remove-SFDrive CmdLet. A node cannot be removed until the RemoveDrives process has completed and all data has been migrated away from the node. -Once removed, a node registers itself as a pending node and can be added again, or shut down which removes it from the Pending Node list. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFNode -NodeID 4 -Confirm:$false - - Removes node ID 4 with no confirmation prompt. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Remove-SFNode -NodeID 4,5,6,7,8 -Confirm:$false - - Removes nodes with ID 4,5,6,7,8 with no confirmation prompt. - - - - - - - Remove-SFNodeSupportBundle - - [Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet. - - - - - Remove - SFNodeSupportBundle - - - - [Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet. - - - - - - - Remove-SFNodeSupportBundle is used to delete all support bundles generated with the New-SFNodeSupportBundle CmdLet. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFNodeSupportBundle - - Removes all support bundles from a node. - - - - - - - Remove-SFSchedule - - [Cluster] Deletes a schedule. - - - - - Remove - SFSchedule - - - - [Cluster] Deletes a schedule. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - ScheduleID - - Schedule ID(s) to remove - - long[] - - long[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Deletes a schedule. - - - - - - - - - - Schedule[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFSchedule -ScheduleID 1 -Confirm:$false - - Removes schedule with ID 1 with no confirmation prompt. TO be more specific, sets variable "ToBeDeleted" to True on specified shedule. - - - - - - - Remove-SFSnapshot - - [Cluster] Deletes a snapshot. - - - - - Remove - SFSnapshot - - - - [Cluster] Deletes a snapshot. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - Snapshot ID(s) to remove - - long[] - - long[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Deletes a snapshot. - - - - - - - - - - Snapshot[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFSnapshot -SnapshotID 37 - - Removes the specified snapshot(s). - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolume -Name "*VMware*" | Remove-SFSnapshot - - Removes all snapshots on any volumes that have "VMware" in the volume name. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFSnapshot -SnapshotName "Saturday*" | Remove-SFSnapshot - - Removes all snapshots on the cluster that include "Saturday" in the snapshot name. - - - - - - - Remove-SFStorageContainer - - Removes a storage container when you provide an ID. - - - - - Remove - SFStorageContainer - - - - Removes a storage container when you provide an ID. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - StorageContainerID - - list of storageContainerID of the storage containers to delete. - - guid[] - - guid[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Guid[] - - - - - Removes a storage container when you provide an ID. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFStorageContainer -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff - - Removes storage container with specified ID with no confirmation prompt. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff". - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Once removed, a node registers itself as a pending node and can be added again, or shut down which removes it from the Pending Node list. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFNode -NodeID 4 -Confirm:$false + + Removes node ID 4 with no confirmation prompt. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFNode -NodeID 4,5,6,7,8 -Confirm:$false + + Removes nodes with ID 4,5,6,7,8 with no confirmation prompt. + + + + + + + Remove-SFNodeSSLCertificate + + [Node] Removes the management node's SSL certificate. + + + + + Remove + SFNodeSSLCertificate + + + + [Node] Removes the management node's SSL certificate. + + + + Remove-SFNodeSSLCertificate + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFNodeSSLCertificate + + Removes the management node's SSL certificate. + + + + + + + Remove-SFNodeSupportBundle + + [Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet. + + + + + Remove + SFNodeSupportBundle + + + + [Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet. + + + + Remove-SFNodeSupportBundle + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + Remove-SFNodeSupportBundle is used to delete all support bundles generated with the New-SFNodeSupportBundle CmdLet. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFNodeSupportBundle + + Removes all support bundles from a node. + + + + + + + Remove-SFQoSPolicy + + Deletes an existing QoS Policy. + + + + + Remove + SFQoSPolicy + + + + Deletes an existing QoS Policy. Any volumes associated with the QoS Policy will retain the current QoS settings, but will no longer be associated with a policy. + + + + Remove-SFQoSPolicy + + QoSPolicyID + + The ID of the policy to be deleted + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + QoSPolicyID + + The ID of the policy to be deleted + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int32 + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFQoSPolicy -QoSPolicyID 14 -Confirm:$false + + Deletes the QoS Policy with ID 14. + + + + + + + Remove-SFSchedule + + [Cluster] Deletes a schedule. + + + + + Remove + SFSchedule + + + + [Cluster] Deletes a schedule. + + + + Remove-SFSchedule + + ScheduleID + + Schedule ID(s) to remove + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + ScheduleID + + Schedule ID(s) to remove + + long[] + + long[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + + + + Schedule[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFSchedule -ScheduleID 1 -Confirm:$false + + Removes schedule with ID 1 with no confirmation prompt. TO be more specific, sets variable "ToBeDeleted" to True on specified shedule. + + + + + + + Remove-SFSnapMirrorEndpoints + + [Cluster] Remove-SFSnapMirrorEndpoints deletes one or more SnapMirror endpoints from the system. + + + + + Remove + SFSnapMirrorEndpoints + + + + [Cluster] Remove-SFSnapMirrorEndpoints deletes one or more SnapMirror endpoints from the system. + + + + Remove-SFSnapMirrorEndpoints + + SnapMirrorEndpointIDs + + An array of IDs of SnapMirror endpoints to delete. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFSnapMirrorEndpoints + + SnapMirrorEndpoint + + An array of SnapMirror endpoints to delete. + + SnapMirrorEndpoint[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpoint + + An array of SnapMirror endpoints to delete. + + SnapMirrorEndpoint[] + + SnapMirrorEndpoint[] + + + + + SnapMirrorEndpointIDs + + An array of IDs of SnapMirror endpoints to delete. + + long[] + + long[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + SolidFire.Element.Api.SnapMirrorEndpoint[] + + + + + + + + + + + + + DeleteSnapMirrorEndpointsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DeleteSnapMirrorEndpointsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFSnapMirrorEndpoints -SnapMirrorEndpointIDs 1,2 + + Deletes the two endpoints by ID. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorEndpoints | Remove-SFSnapMirrorEndpoint -Confirm:$false + + Removes ALL endpoints from the cluster. + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Get-SFSnapMirrorEndpoints -SnapMirrorEndpointID 1,2 | Remove-SFSnapMirrorEndpoint -Confirm:$false + + Removes ALL endpoints that meet the Get command's criteria from the cluster. + + + + + + + Remove-SFSnapMirrorRelationships + + [Cluster] Remove-SFSnapMirrorRelationships removes a SnapMirror relationship between a source and destination endpoint. + + + + + Remove + SFSnapMirrorRelationships + + + + [Cluster] Remove-SFSnapMirrorRelationships removes a SnapMirror relationship between a source and destination endpoint. + + + + Remove-SFSnapMirrorRelationships + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFSnapMirrorRelationships + + Relationships + + An array of relationships to remove. (Probably passed in from Get-SFSnapMirrorRelationships. + + SnapMirrorRelationship[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + Relationships + + An array of relationships to remove. (Probably passed in from Get-SFSnapMirrorRelationships. + + SnapMirrorRelationship[] + + SnapMirrorRelationship[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + SolidFire.Element.Api.SnapMirrorRelationship[] + + + + + + + + + + + + + DeleteSnapMirrorRelationshipsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DeleteSnapMirrorRelationshipsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFSnapMirrorRelationships $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName -Confirm:$false + + Removes a SnapMirror relationship from the specified endpoint. Destination volume information is required. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFSnapMirrorRelationships | Remove-SFSnapMirrorRelationships -Confirm:$false + + Removes all SnapMirror relationships from the cluster. This goes through all endpoints and removes the relationships. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSnapMirrorRelationships -Vserver $vserverName | Remove-SFSnapMirrorRelationships -Confirm:$false + + Removes all relationships that are related to the specified vserver. + + + + + + + Remove-SFSnapshot + + [Cluster] Deletes a snapshot. + + + + + Remove + SFSnapshot + + + + [Cluster] Deletes a snapshot. + + + + Remove-SFSnapshot + + SnapshotID + + Snapshot ID(s) to remove + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + Snapshot ID(s) to remove + + long[] + + long[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + + + + Snapshot[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFSnapshot -SnapshotID 37 + + Removes the specified snapshot(s). + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "*VMware*" | Remove-SFSnapshot + + Removes all snapshots on any volumes that have "VMware" in the volume name. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFSnapshot -SnapshotName "Saturday*" | Remove-SFSnapshot + + Removes all snapshots on the cluster that include "Saturday" in the snapshot name. + + + + + + + Remove-SFSSLCertificate + + [Cluster] Removes the cluster's SSL certificate. + + + + + Remove + SFSSLCertificate + + + + [Cluster] Removes the cluster's SSL certificate. + + + + Remove-SFSSLCertificate + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFSSLCertificate + + Removes the cluster's SSL certificate. + + + + + + + Remove-SFStorageContainer + + Removes a storage container when you provide an ID. + + + + + Remove + SFStorageContainer + + + + Removes a storage container when you provide an ID. + + + + Remove-SFStorageContainer + + StorageContainerID + + list of storageContainerID of the storage containers to delete. + + guid[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StorageContainerID + + list of storageContainerID of the storage containers to delete. + + guid[] + + guid[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Guid[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFStorageContainer -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff + + Removes storage container with specified ID with no confirmation prompt. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff". + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $containers = Get-SFStorageContainer -Remove-SFStorageContainer -StorageContainerID $containers[4].StorageContainerID -Confirm:$false - - Removes 5th storage container with no confirmation prompt. - - - - - - - Remove-SFVirtualNetwork - - [Cluster] Removes a configured virtual network for the cluster. - - - - - Remove - SFVirtualNetwork - - - - [Cluster] Removes a configured virtual network for the cluster. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualNetworkID - - Enter a VirtualNetworkID to remove. - - long - - long - - - - - - VirtualNetworkTag - - Enter a VirtualNetworkTag to remove. - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 - - - - - [Cluster] Removes a configured virtual network for the cluster. - - - - - - - After removing the VirtualNetwork, return the list of remaining VirtualNetworks. - - - VirtualNetwork[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFVirtualNetwork -VirtualNetworkID 18 - - Removes the virtual network identified by virtual network ID 18. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Remove-SFVirtualNetwork -VirtualNetworkTag 1280 - - Removes the virtual network associated with VLAN tag 1280. - - - - - - - Remove-SFVolume - - [Cluster] Marks an active volume for deletion. - - - - - Remove - SFVolume - - - - [Cluster] Marks an active volume for deletion. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - Enter a volume ID - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Marks an active volume for deletion. - - - - - - +Remove-SFStorageContainer -StorageContainerID $containers[4].StorageContainerID -Confirm:$false + + Removes 5th storage container with no confirmation prompt. + + + + + + + Remove-SFVirtualNetwork + + [Cluster] Removes a configured virtual network for the cluster. + + + + + Remove + SFVirtualNetwork + + + + [Cluster] Removes a configured virtual network for the cluster. + + + + Remove-SFVirtualNetwork + + VirtualNetworkID + + + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Remove-SFVirtualNetwork + + VirtualNetworkTag + + Enter a VirtualNetworkTag to remove. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualNetworkID + + Enter a VirtualNetworkID to remove. + + long + + long + + + + + VirtualNetworkTag + + Enter a VirtualNetworkTag to remove. + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 + + + + + + + + + + After removing the VirtualNetwork, return the list of remaining VirtualNetworks. + + + VirtualNetwork[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFVirtualNetwork -VirtualNetworkID 18 + + Removes the virtual network identified by virtual network ID 18. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Remove-SFVirtualNetwork -VirtualNetworkTag 1280 + + Removes the virtual network associated with VLAN tag 1280. + + + + + + + Remove-SFVolume + + [Cluster] Marks an active volume for deletion. + + + + + Remove + SFVolume + + + + [Cluster] Marks an active volume for deletion. + + + + Remove-SFVolume + + VolumeID + + Enter a volume ID + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + Enter a volume ID + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + Marks an active volume for deletion. It is purged (permanently deleted) after the cleanup interval elapses (generally 8 hours). After making a request to delete a volume, any active iSCSI connections to the volume is immediately terminated and no further connections are allowed while the volume is in this state. It is not returned in target discovery requests. Any snapshots of a volume that has been marked to delete are not affected. Snapshots are kept until the volume is purged from the system. If a volume is marked for deletion, and it has a bulk volume read or bulk volume write operation in progress, the bulk volume read or write process is stopped. -If the volume you delete is paired with a volume, replication between the paired volumes is suspended and no data is transferred to it or from it while in a deleted state. The remote volume the deleted volume was paired with enters into a PausedMisconfigured state and data is no longer sent to it or from the deleted volume. Until the deleted volume is purged, it can be restored and data transfers resumes. If the deleted volume gets purged from the system, the volume it was paired with enters into a StoppedMisconfigured state and the volume pairing status is removed. The purged volume becomes permanently unavailable. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFVolume -VolumeID 12 - - Removes volume ID 12. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolume -Name "VMware01" | Remove-SFVolume - - Remove all volumes named "VMware01". - - - - - - - Remove-SFVolumeAccessGroup - - [Cluster] Removes a volume access group from the cluster. - - - - - Remove - SFVolumeAccessGroup - - - - [Cluster] Removes a volume access group from the cluster. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - volume access group ID(s) to remove - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Removes a volume access group from the cluster. - - - - - - - Removes a volume access group from the cluster. Volume access groups can be removed even if there are active volumes associated. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFVolumeAccessGroup -VolumeAccessGroupID 13 - - Removes volume access group ID 13. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Get-SFVolumeAccessGroup -VolumeAccessGroupName "SQLCluster01" | Remove-SFVolumeAccessGroup - - Removes the volume access group named "SQLCluster01". - - - - - - - Remove-SFVolumeFromVolumeAccessGroup - - [Cluster] Removes one or more volumes from a volume access group. - - - - - Remove - SFVolumeFromVolumeAccessGroup - - - - [Cluster] Removes one or more volumes from a volume access group. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - Enter a volume access group ID or list of volume access group IDs - - long - - long - - - - - - VolumeID - - List of volume IDs to remove from the volume access group - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.Int64[] - - - - - [Cluster] Removes one or more volumes from a volume access group. - - - - - - - - - - VolumeAccessGroup - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFVolumeFromVolumeAccessGroup -VolumeAccessGroupID 3 -VolumeID 12 - - Removes volume ID 12 from volume access group ID 3. This does not delete the volume, it only removes access from the initiators in the volume access group. - - - - - - - Remove-SFVolumePair - - [Cluster] Removes the remote pairing between two volumes. - - - - - Remove - SFVolumePair - - - - [Cluster] Removes the remote pairing between two volumes. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - ID of the volume on which to stop the replication process. - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 - - - - - [Cluster] Removes the remote pairing between two volumes. - - - - - - - - - - RemoveVolumePairResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RemoveVolumePairResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Remove-SFVolumePair -VolumeID 9 -Confirm:$false - - Removes pairing from volume ID 9 with no confirmation prompt. - - - - - - - Reset-SFDrive - - [Cluster] Reset one or more drives to be reused in a node. - - - - - Reset - SFDrive - - - - ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call. - - - - Confirm - - ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call. - - - switch - - - - - - Drive - - List of Drives (not driveIDs) to reset. - - DriveInfo[] - - DriveInfo[] - - - - - - DriveID - - List of DriveIDs to reset. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call. - - - switch - - - - - - - - - System.Int64[] -SolidFire.Element.Api.DriveInfo[] - - - - - ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call. - - - - - - - - - - ResetDriveDetails[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResetDriveDetails.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Reset-SFDrive -DriveID 19 - - Resets drive ID 19. - - - - - - - Reset-SFNode - - [Node] Reset a node. - - - - - Reset - SFNode - - - - The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state. - - - - Build - - Used to specify the URL to a remote Element software image to which the node will be reset. - - string - - string - - - - - - Confirm - - The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state. - - - switch - - - - - - Options - - Used to enter specifications for running the reset operation. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state. - - - switch - - - - - - - - - None - - - - - The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state. - - - - - - - - - - ResetNodeDetails - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResetNodeDetails.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Reset-SFNode - - Reset the node. - - - - - - - Restart-SFNetworking - - [Node] Restart networking services on node. - - - - - Restart - SFNetworking - - - - The RestartNetworking API method is used to restart the networking services on a node. - - - - Confirm - - The RestartNetworking API method is used to restart the networking services on a node. - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - The RestartNetworking API method is used to restart the networking services on a node. - - - switch - - - - - - - - - None - - - - - The RestartNetworking API method is used to restart the networking services on a node. - - - - - - - - - - Hashtable - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Restart-SFNetworking - - Restart networking on the node. - - - - - - - Restart-SFServices - - [Node] Restart services on node. - - - - - Restart - SFServices - - - - The RestartServices API method is used to restart the services on a node. - - - - Action - - Action to perform on the service (start, stop, restart). - - string - - string - - - - - - Confirm - - The RestartServices API method is used to restart the services on a node. - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Service - - Service name to be restarted. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - The RestartServices API method is used to restart the services on a node. - - - switch - - - - - - - - - None - - - - - The RestartServices API method is used to restart the services on a node. - - - - - - - - - - Hashtable - - - - - - - - - - Set-SFAccount - - [Cluster] Modifies an existing account. - - - - - Set - SFAccount - - - - [Cluster] Modifies an existing account. - - - - AccountID - - AccountID for the account to modify - - long - - long - - - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - InitiatorSecret - - CHAP secret to use for the initiator - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Status - - Status to set the account to. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - TargetSecret - - CHAP secret to use for the target - - string - - string - - - - - - Username - - Change username for this account - - string - - string - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String -System.Collections.Hashtable - - - - - [Cluster] Modifies an existing account. - - - - - - - - - - Account - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFAccount -AccountID 2 -Status "locked" - - Locks the account with account ID 2. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFAccount -AccountID 2 -InitiatorSecret 3ks03ks02l4@1k -TargetSecret 3ks03ks02l4@!l - - Modifies the CHAP secrets for the account with ID 2. - - - - - - - Set-SFClusterAdmin - - [Cluster] Modifies properties on a cluster admin account (password and access). - - - - - Set - SFClusterAdmin - - - - [Cluster] Modifies properties on a cluster admin account (password and access). - - - - Access - - Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API. - - string[] - - string[] - - - - - - Attributes - - List of Name/Value pairs in JSON object format. - - hashtable - - hashtable - - - - - - ClusterAdminID - - ClusterAdminID for the Cluster Admin or LDAP Cluster Admin to modify. - - long - - long - - - - - - Confirm - - - - - switch - - - - - - Password - - Password used to authenticate this Cluster Admin. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String -System.String[] - - - - - [Cluster] Modifies properties on a cluster admin account (password and access). - - - - - - - - - - ClusterAdmin - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFClusterAdmin -ClusterAdminID 3 -Password "NewAdminPassword" - +If the volume you delete is paired with a volume, replication between the paired volumes is suspended and no data is transferred to it or from it while in a deleted state. The remote volume the deleted volume was paired with enters into a PausedMisconfigured state and data is no longer sent to it or from the deleted volume. Until the deleted volume is purged, it can be restored and data transfers resumes. If the deleted volume gets purged from the system, the volume it was paired with enters into a StoppedMisconfigured state and the volume pairing status is removed. The purged volume becomes permanently unavailable. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFVolume -VolumeID 12 + + Removes volume ID 12. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VMware01" | Remove-SFVolume + + Remove all volumes named "VMware01". + + + + + + + Remove-SFVolumeAccessGroup + + [Cluster] Removes a volume access group from the cluster. + + + + + Remove + SFVolumeAccessGroup + + + + [Cluster] Removes a volume access group from the cluster. + + + + Remove-SFVolumeAccessGroup + + VolumeAccessGroupID + + volume access group ID(s) to remove + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + volume access group ID(s) to remove + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + Removes a volume access group from the cluster. Volume access groups can be removed even if there are active volumes associated. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFVolumeAccessGroup -VolumeAccessGroupID 13 + + Removes volume access group ID 13. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Get-SFVolumeAccessGroup -VolumeAccessGroupName "SQLCluster01" | Remove-SFVolumeAccessGroup + + Removes the volume access group named "SQLCluster01". + + + + + + + Remove-SFVolumeFromVolumeAccessGroup + + [Cluster] Removes one or more volumes from a volume access group. + + + + + Remove + SFVolumeFromVolumeAccessGroup + + + + [Cluster] Removes one or more volumes from a volume access group. + + + + Remove-SFVolumeFromVolumeAccessGroup + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs + + long + + + + VolumeID + + List of volume IDs to remove from the volume access group + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroupID + + Enter a volume access group ID or list of volume access group IDs + + long + + long + + + + + VolumeID + + List of volume IDs to remove from the volume access group + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.Int64[] + + + + + + + + + + + + + VolumeAccessGroup + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFVolumeFromVolumeAccessGroup -VolumeAccessGroupID 3 -VolumeID 12 + + Removes volume ID 12 from volume access group ID 3. This does not delete the volume, it only removes access from the initiators in the volume access group. + + + + + + + Remove-SFVolumePair + + [Cluster] Removes the remote pairing between two volumes. + + + + + Remove + SFVolumePair + + + + [Cluster] Removes the remote pairing between two volumes. + + + + Remove-SFVolumePair + + VolumeID + + ID of the volume on which to stop the replication process. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + ID of the volume on which to stop the replication process. + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 + + + + + + + + + + + + + RemoveVolumePairResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RemoveVolumePairResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Remove-SFVolumePair -VolumeID 9 -Confirm:$false + + Removes pairing from volume ID 9 with no confirmation prompt. + + + + + + + Reset-SFDrive + + [Node] Reset one or more drives to be reused in a node. + + + + + Reset + SFDrive + + + + ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call. + + + + Reset-SFDrive + + DeviceName + + List of device names to reset. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + DeviceName + + List of device names to reset. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ResetDriveDetails[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResetDriveDetails.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Reset-SFDrive -DeviceName slot3 + + Resets the drive with device name "slot3". + + + + + + + Reset-SFNode + + [Node] Reset a node. + + + + + Reset + SFNode + + + + The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state. + + + + Reset-SFNode + + Build + + Used to specify the URL to a remote Element software image to which the node will be reset. + + string + + + + Options + + Used to enter specifications for running the reset operation. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Build + + Used to specify the URL to a remote Element software image to which the node will be reset. + + string + + string + + + + + Confirm + + + + + switch + + + + + Options + + Used to enter specifications for running the reset operation. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ResetNodeDetails + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResetNodeDetails.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Reset-SFNode + + Reset the node. + + + + + + + Reset-SFNodeSupplementalTlsCiphers + + [Node] Reset-SFSupplementalTlsCiphers restores the supplemental ciphers to their defaults. + + + + + Reset + SFNodeSupplementalTlsCiphers + + + + [Restore] Reset-SFSupplementalTlsCiphers restores the supplemental ciphers to their defaults. + + + + Reset-SFNodeSupplementalTlsCiphers + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ResetSupplementalTlsCiphersResult + + + + + + + + + Reset-SFSupplementalTlsCiphers + + [Cluster] Reset-SFSupplementalTlsCiphers restores the supplemental ciphers to their defaults. + + + + + Reset + SFSupplementalTlsCiphers + + + + [Cluster] Reset-SFSupplementalTlsCiphers restores the supplemental ciphers to their defaults. + + + + Reset-SFSupplementalTlsCiphers + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ResetSupplementalTlsCiphersResult + + + + + + + + + Restart-SFNetworking + + [Node] Restart networking services on node. + + + + + Restart + SFNetworking + + + + The RestartNetworking API method is used to restart the networking services on a node. + + + + Restart-SFNetworking + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + Hashtable + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Restart-SFNetworking + + Restart networking on the node. + + + + + + + Restart-SFServices + + [Node] Restart services on node. + + + + + Restart + SFServices + + + + The RestartServices API method is used to restart the services on a node. + + + + Restart-SFServices + + Action + + Action to perform on the service (start, stop, restart). + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Action + + Action to perform on the service (start, stop, restart). + + string + + string + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Service + + Service name to be restarted. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + Hashtable + + + + + + + + + Resume-SFSnapMirrorRelationship + + [Cluster] Resume-SFSnapMirrorRelationship enables future transfers for a quiesced SnapMirror relationship. + + + + + Resume + SFSnapMirrorRelationship + + + + [Cluster] Resume-SFSnapMirrorRelationship enables future transfers for a quiesced SnapMirror relationship. + + + + Resume-SFSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ResumeSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResumeSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Resume-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Reverses the effects of an earlier Invoke-SFQuiesceSnapMirrorRelationship call. + + + + + + + Set-SFAccount + + [Cluster] Modifies an existing account. + + + + + Set + SFAccount + + + + [Cluster] Modifies an existing account. + + + + Set-SFAccount + + AccountID + + AccountID for the account to modify + + long + + + + Status + + Status to set the account to. + + string + + + + InitiatorSecret + + CHAP secret to use for the initiator + + string + + + + TargetSecret + + CHAP secret to use for the target + + string + + + + Username + + Change username for this account + + string + + + + Attributes + + Attributes to set + + hashtable + + + + EnableChap + + Specify if chap account credentials can be used by an initiator to access volumes. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AccountID + + AccountID for the account to modify + + long + + long + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + EnableChap + + Specify if chap account credentials can be used by an initiator to access volumes. + + bool + + bool + + + + + InitiatorSecret + + CHAP secret to use for the initiator + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Status + + Status to set the account to. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TargetSecret + + CHAP secret to use for the target + + string + + string + + + + + Username + + Change username for this account + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +System.Collections.Hashtable + + + + + + + + + + + + + Account + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFAccount -AccountID 2 -Status "locked" + + Locks the account with account ID 2. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFAccount -AccountID 2 -InitiatorSecret 3ks03ks02l4@1k -TargetSecret 3ks03ks02l4@!l + + Modifies the CHAP secrets for the account with ID 2. + + + + + + + Set-SFClusterAdmin + + [Cluster] Modifies properties on a cluster admin account (password and access). + + + + + Set + SFClusterAdmin + + + + [Cluster] Modifies properties on a cluster admin account (password and access). + + + + Set-SFClusterAdmin + + ClusterAdminID + + ClusterAdminID for the Cluster Admin or LDAP Cluster Admin to modify. + + long + + + + Password + + Password used to authenticate this Cluster Admin. + + string + + + + Access + + Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API. + + string[] + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Access + + Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API. + + string[] + + string[] + + + + + Attributes + + List of Name/Value pairs in JSON object format. + + hashtable + + hashtable + + + + + ClusterAdminID + + ClusterAdminID for the Cluster Admin or LDAP Cluster Admin to modify. + + long + + long + + + + + Confirm + + + + + switch + + + + + Password + + Password used to authenticate this Cluster Admin. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +System.String[] + + + + + + + + + + + + + ClusterAdmin + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFClusterAdmin -ClusterAdminID 3 -Password "NewAdminPassword" + Changes the password of the specified cluster admin. -Note: Changing the password on the account currently being used to connect to the cluster will result in future cmdlets failing. You will need to change the admin password, disconnect from the cluster and reconnect with the update credentials. - - - - - - - Set-SFClusterConfig - - [Node] Sets the cluster configuration options for a node. - - - - - Set - SFClusterConfig - - - - [Node] Sets the cluster configuration options for a node. - - - - Cluster - - Name of the cluster - - string - - string - - - - - - Confirm - - - - - switch - - - - - - Mipi - - The management interface of the node (Bond1G or Bond10G) - - string - - string - - - - - - Name - - Hostname of the node - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String - - - - - [Node] Sets the cluster configuration options for a node. - - - - - - - - - - ClusterConfig - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterConfig.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFClusterConfig -Name "Node1" -Cluster "TestCluster - - Sets the node's hostname to "Node1" and adds it as a pending node for "TestCluster". - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFClusterConfig -Mipi Bond1G - - Sets the node's management interface to "Bond1G". - - - - - - - Set-SFClusterFullThreshold - - [Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested. - - - - - Set - SFClusterFullThreshold - - - - [Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested. - - - - Confirm - - - - - switch - - - - - - MaxMetadataOverProvisionFactor - - A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Stage2AwareThreshold - - Number of nodes worth of capacity remaining on the cluster that triggers a notification. For version Nitrogen (7.0) or lower. - - long - - long - - - - - - Stage3BlockThresholdPercent - - The percent value set for stage3. At this percent full, a warning will be posted in the Alerts log. For version Oxygen (8.0) or higher. - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested. - - - - - - - - - - ModifyClusterFullThresholdResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyClusterFullThresholdResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFClusterFullThreshold -MaxMetadataOverProvisionFactor 100 -Stage3BlockThresholdPercent 50 -Confirm:$false - - Sets percentage threshold for Oxygen(8.0) or higher along with setting MaxMetadataOverProvisionFactor with no confirmation prompt. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFClusterFullThreshold -MaxMetadataOverProvisionFactor 100 -Stage2AwareThreshold 2 -Confirm:$false - - Sets node number threshold for Nitrogen (7.0) or lower along with setting MaxMetadataOverProvisionFactor with no confirmation prompt. - - - - - - - Set-SFDefaultQoS - - Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. - - - - - Set - SFDefaultQoS - - - - Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. - - - - BurstIOPS - - The maximum number of IOPS allowed in a short burst scenario. - - long - - long - - - - - - MaxIOPS - - The maximum number of sustained IOPS that are provided by the cluster to a volume. - - long - - long - - - - - - MinIOPS - - The minimum number of sustained IOPS that are provided by the cluster to a volume. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. - - - - - - - SetDefaultQoS enables you to configure the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFDefaultQoS - - Outputs currently set QoS values. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFDefaultQoS -MinIOPS 100 -MaxIOPS 17500 -BurstIOPS 17500 - - Sets default QoS values to specified values then outputs them. - - - - - - - Set-SFGroupSnapshot - - [Cluster] Modifies a point-in-time snapshot of a group of volumes. - - - - - Set - SFGroupSnapshot - - - - [Cluster] Modifies a point-in-time snapshot of a group of volumes. - - - - Confirm - - - - - switch - - - - - - EnableRemoteReplication - - Use to enable the snapshot created to be replicated to a remote SolidFire cluster. - - bool - - bool - - - - - - ExpirationTime - - Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string. - - string - - string - - - - - - GroupSnapshotID - - Unique ID(s) of the Group Snapshot. - - long[] - - long[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Modifies a point-in-time snapshot of a group of volumes. - - - - - - - - - - GroupSnapshot - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFGroupSnapshot -GroupSnapshotID 3 -EnableRemoteReplication:$false - - Disables Remote Replication on specified GroupSnapshot. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFGroupSnapshot -GroupSnapshotID 2,3 -EnableRemoteReplication:$true -ExpirationTime 2018-05-31T16:32:16 - - Enables Remote Replication and sets ExpirationTime on both GroupSnapshots 2 and 3. - - - - - - - Set-SFInitiator - - Sets the attributes of an existing initiator. - - - - - Set - SFInitiator - - - - Sets the attributes of an existing initiator. - - - - Alias - - The friendly name to assign to this initiator. - - string - - string - - - - - - Attributes - - A set of Hashtable attributes assigned to this initiator. - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - InitiatorID - - The numeric ID of the initiator to modify. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroupID - - The ID of the volume access group into to which this newly created initiator will be added. - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 - - - - - Sets the attributes of an existing initiator. - - - - - - - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFInitiator -InitiatorID 11 -Alias Initiator11 -Confirm:$false - - Sets the Initiator's Alias to the given value with no confirmation prompt. In this case, InitiatorID: '11', and Alias: 'Initiator11'. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFInitiator -InitiatorID 7 -VolumeAccessGroupID 1 -Confirm:$false - - Adds initiator 11 to the given VolumeAccessGroup using ID with no confirmation prompt. In this case, InitiatorID: '7', and VolumeAccessGroupID: '1'. - - - - - - - Set-SFLdapAuthentication - - [Cluster] Enables or disables LDAP configuration. - - - - - Set - SFLdapAuthentication - - - - [Cluster] Enables or disables LDAP configuration. - - - - AuthType - - Identifies which user authentication method will be used. Must be one of the following: DirectBind, SearchAndBind. - - string - - string - - - - - - Disable - - Use this parameter to disable LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored. - - - switch - - - - - - GroupSearchBaseDN - - The base DN of the tree to start the group search. - - string - - string - - - - - - GroupSearchCustomFilter - - For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a user's groups. The string can have placeholder text of %USERNAME% and %USERDN% to be replaced with their username and full userDN as needed. REQUIRED for CustomFilter. - - string - - string - - - - - - GroupSearchType - - Controls the default group search filter used, must be one of the following: NoGroups, ActiveDirectory MemberDN. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SearchBindDN - - A fully qualified DN to log in with to perform an LDAP search for the user. REQUIRED for SearchAndBind. - - string - - string - - - - - - SearchBindPassword - - The password for the SearchBindDN account used for searching. REQUIRED for SearchAndBind. - - string - - string - - - - - - ServerURIs - - An array of LDAP server URIs (examples: ldap://1.2.3.4 and ldaps://1.2.3.4:123) - - string[] - - string[] - - - - - - Target - - - - string[] - - string[] - - - - - - UserDNTemplate - - A string that will be used to form a fully qualified user DN. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for DirectBind. - - string - - string - - - - - - UserSearchBaseDN - - The base DN of the tree to start the search. REQUIRED for SearchAndBind. - - string - - string - - - - - - UserSearchFilter - - The LDAP filter to use. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for SearchAndBind. - - string - - string - - - - - - - - - System.String -System.String[] - - - - - [Cluster] Enables or disables LDAP configuration. - - - - - - - - - - LdapConfiguration - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LdapConfiguration.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFLdapAuthentication -Disable - - Disables the LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored. - - - - - - - Set-SFLoginSessionInfo - - [Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers. - - - - - Set - SFLoginSessionInfo - - - - [Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers. - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Timeout - - Cluster authentication expiration period. Formatted in HH:mm:ss. - - string - - string - - - - - - WhatIf - - - - - switch - - - - - - - - - None - - - - - [Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers. - - - - - - - - - - LoginSessionInfo - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoginSessionInfo.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFLoginSessionInfo -Timeout 00:35:00 - - Sets the timeout period to specified amount. - - - - - - - Set-SFLunAssignment - - [Cluster] Defines custom LUN assignments for specific volumes. - - - - - Set - SFLunAssignment - - - - [Cluster] Defines custom LUN assignments for specific volumes. - - - - Confirm - - - - - switch - - - - - - LunAssignment - - Enter a LunAssignment - - LunAssignment[] - - LunAssignment[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeAccessGroup - - Enter a volume access group - - VolumeAccessGroup - - VolumeAccessGroup - - - - - - VolumeAccessGroupID - - Enter a volume access group ID - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -SolidFire.Element.Api.VolumeAccessGroup -SolidFire.Element.Api.LunAssignment[] - - - - - [Cluster] Defines custom LUN assignments for specific volumes. - - - - - - - - - - VolumeAccessGroupLunAssignments - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroupLunAssignments.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +Note: Changing the password on the account currently being used to connect to the cluster will result in future cmdlets failing. You will need to change the admin password, disconnect from the cluster and reconnect with the update credentials. + + + + + + + Set-SFClusterConfig + + [Node] Sets the cluster configuration options for a node. + + + + + Set + SFClusterConfig + + + + [Node] Sets the cluster configuration options for a node. + + + + Set-SFClusterConfig + + Name + + Hostname of the node + + string + + + + Cluster + + Name of the cluster + + string + + + + Mipi + + The management interface of the node (Bond1G or Bond10G) + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Cluster + + Name of the cluster + + string + + string + + + + + Confirm + + + + + switch + + + + + Mipi + + The management interface of the node (Bond1G or Bond10G) + + string + + string + + + + + Name + + Hostname of the node + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String + + + + + + + + + + + + + ClusterConfig + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterConfig.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFClusterConfig -Name "Node1" -Cluster "TestCluster" + + Sets the node's hostname to "Node1" and adds it as a pending node for "TestCluster". + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFClusterConfig -Mipi Bond1G + + Sets the node's management interface to "Bond1G". + + + + + + + Set-SFClusterFullThreshold + + [Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested. + + + + + Set + SFClusterFullThreshold + + + + [Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested. + + + + Set-SFClusterFullThreshold + + Stage2AwareThreshold + + Number of nodes worth of capacity remaining on the cluster that triggers a notification. For version Nitrogen (7.0) or lower. + + long + + + + MaxMetadataOverProvisionFactor + + A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Set-SFClusterFullThreshold + + Stage3BlockThresholdPercent + + The percent value set for stage3 Block Storage Utilization. At this percent full, a warning will be posted in the Alerts log. For version Oxygen (8.0) or higher. + + long + + + + MaxMetadataOverProvisionFactor + + A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Set-SFClusterFullThreshold + + Stage3MetadataThresholdPercent + + The percent value set for stage3 Metadata Storage Utilization. At this percent full, a warning will be posted in the Alerts log. + + long + + + + MaxMetadataOverProvisionFactor + + A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + MaxMetadataOverProvisionFactor + + A value representative of the number of times metadata space can be over provisioned relative to the amount of space available. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Stage2AwareThreshold + + Number of nodes worth of capacity remaining on the cluster that triggers a notification. For version Nitrogen (7.0) or lower. + + long + + long + + + + + Stage3BlockThresholdPercent + + The percent value set for stage3 Block Storage Utilization. At this percent full, a warning will be posted in the Alerts log. For version Oxygen (8.0) or higher. + + long + + long + + + + + Stage3MetadataThresholdPercent + + The percent value set for stage3 Metadata Storage Utilization. At this percent full, a warning will be posted in the Alerts log. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ModifyClusterFullThresholdResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyClusterFullThresholdResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFClusterFullThreshold -MaxMetadataOverProvisionFactor 100 -Stage3BlockThresholdPercent 50 -Confirm:$false + + Sets percentage threshold for Oxygen(8.0) or higher along with setting MaxMetadataOverProvisionFactor with no confirmation prompt. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFClusterFullThreshold -MaxMetadataOverProvisionFactor 100 -Stage2AwareThreshold 2 -Confirm:$false + + Sets node number threshold for Nitrogen (7.0) or lower along with setting MaxMetadataOverProvisionFactor with no confirmation prompt. + + + + + + + Set-SFClusterInterfacePreference + + [Cluster] Lets you modify a value to the key-value store. + + + + + Set + SFClusterInterfacePreference + + + + [Cluster] Modifies an existing cluster interface preference. + + + + Set-SFClusterInterfacePreference + + Name + + Name of the key you wish to change. + + string + + + + Value + + Value stored in the key-value store you wish to change. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Name + + Name of the key you wish to change. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Value + + Value stored in the key-value store you wish to change. + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + ModifyClusterInterfacePreferenceResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyClusterInterfacePreferenceResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFClusterInterfacePreference -Name "bestPet" -Value "pooch" + + Modifies a new entry to the key-value store. + + + + + + + Set-SFDefaultQoS + + Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. + + + + + Set + SFDefaultQoS + + + + Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. + + + + Set-SFDefaultQoS + + MinIOPS + + The minimum number of sustained IOPS that are provided by the cluster to a volume. + + long + + + + MaxIOPS + + The maximum number of sustained IOPS that are provided by the cluster to a volume. + + long + + + + BurstIOPS + + The maximum number of IOPS allowed in a short burst scenario. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + BurstIOPS + + The maximum number of IOPS allowed in a short burst scenario. + + long + + long + + + + + MaxIOPS + + The maximum number of sustained IOPS that are provided by the cluster to a volume. + + long + + long + + + + + MinIOPS + + The minimum number of sustained IOPS that are provided by the cluster to a volume. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + SetDefaultQoS enables you to configure the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFDefaultQoS + + Outputs currently set QoS values. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFDefaultQoS -MinIOPS 100 -MaxIOPS 17500 -BurstIOPS 17500 + + Sets default QoS values to specified values then outputs them. + + + + + + + Set-SFGroupSnapshot + + [Cluster] Modifies a point-in-time snapshot of a group of volumes. + + + + + Set + SFGroupSnapshot + + + + [Cluster] Modifies a point-in-time snapshot of a group of volumes. + + + + Set-SFGroupSnapshot + + GroupSnapshotID + + Unique ID(s) of the Group Snapshot. + + long[] + + + + EnableRemoteReplication + + Use to enable the snapshot created to be replicated to a remote SolidFire cluster. + + bool + + + + ExpirationTime + + Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + EnableRemoteReplication + + Use to enable the snapshot created to be replicated to a remote SolidFire cluster. + + bool + + bool + + + + + ExpirationTime + + Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string. + + string + + string + + + + + GroupSnapshotID + + Unique ID(s) of the Group Snapshot. + + long[] + + long[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + + + + GroupSnapshot + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFGroupSnapshot -GroupSnapshotID 3 -EnableRemoteReplication:$false + + Disables Remote Replication on specified GroupSnapshot. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFGroupSnapshot -GroupSnapshotID 2,3 -EnableRemoteReplication:$true -ExpirationTime 2018-05-31T16:32:16 + + Enables Remote Replication and sets ExpirationTime on both GroupSnapshots 2 and 3. + + + + + + + Set-SFInitiator + + Sets the attributes of an existing initiator. + + + + + Set + SFInitiator + + + + Sets the attributes of an existing initiator. + + + + Set-SFInitiator + + InitiatorID + + The numeric ID of the initiator to modify. + + long + + + + Alias + + The friendly name to assign to this initiator. + + string + + + + VolumeAccessGroupID + + The ID of the volume access group into to which this newly created initiator will be added. + + long + + + + Attributes + + A set of Hashtable attributes assigned to this initiator. + + hashtable + + + + RequireChap + + RequireChap determines if the initiator is required to use CHAP during session login. CHAP is optional if RequireChap is false. + + bool + + + + ChapUsername + + The CHAP username for this initiator. Defaults to the initiator name (IQN) if not specified during creation and RequireChap is true. + + string + + + + InitiatorSecret + + The CHAP secret used for authentication of the initiator. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + + + TargetSecret + + The CHAP secret used for authentication of the target. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + + + VirtualNetworkIDs + + The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Alias + + The friendly name to assign to this initiator. + + string + + string + + + + + Attributes + + A set of Hashtable attributes assigned to this initiator. + + hashtable + + hashtable + + + + + ChapUsername + + The CHAP username for this initiator. Defaults to the initiator name (IQN) if not specified during creation and RequireChap is true. + + string + + string + + + + + Confirm + + + + + switch + + + + + InitiatorID + + The numeric ID of the initiator to modify. + + long + + long + + + + + InitiatorSecret + + The CHAP secret used for authentication of the initiator. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + string + + + + + RequireChap + + RequireChap determines if the initiator is required to use CHAP during session login. CHAP is optional if RequireChap is false. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TargetSecret + + The CHAP secret used for authentication of the target. Defaults to a randomly generated secret if not specified during creation and RequireChap is true. + + string + + string + + + + + VirtualNetworkIDs + + The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks. + + long[] + + long[] + + + + + VolumeAccessGroupID + + The ID of the volume access group into to which this newly created initiator will be added. + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +System.Int64[] + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFInitiator -InitiatorID 11 -Alias Initiator11 -Confirm:$false + + Sets the Initiator's Alias to the given value with no confirmation prompt. In this case, InitiatorID: '11', and Alias: 'Initiator11'. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFInitiator -InitiatorID 7 -VolumeAccessGroupID 1 -Confirm:$false + + Adds initiator 7 to the given VolumeAccessGroup 1 using ID with no confirmation prompt. In this case, InitiatorID: '7', and VolumeAccessGroupID: '1'. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFInitiator -InitiatorID 7 -RequireChap $false -Confirm:$false + + Disables Chap requirement during session login of Initiator 7 with no confirmation prompt. + + + + + + + Set-SFKeyServerKmip + + [Cluster] Sets attributes of a KMIP (Key Management Interoperability Protocol) Key Server. + + + + + Set + SFKeyServerKmip + + + + [Cluster] Sets attributes of a KMIP (Key Management Interoperability Protocol) Key Server. The only required parameter is the keyServerID. A request which contains only the keyServerID will be a no-op and no error will be returned. Any other parameters which are specified will replace the existing values on the KMIP Key Server with the specified keyServerID. Because this server might be part of an active provider this will result in contacting the server to verify it's functional. Multiple hostnames or IP addresses must only be provided to the kmipKeyServerHostnames parameter if the key servers are in a clustered configuration. + + + + Set-SFKeyServerKmip + + KeyServerID + + The port number associated with this KMIP Key Server (typically 5696). + + int + + + + KmipCaCertificate + + The public key certificate of the external key server's root CA. This will be used to verify the certificate presented by external key server in the TLS communication. For key server clusters where individual servers use different CAs, provide a concatenated string containing the root certificates of all the CAs. + + string + + + + KmipClientCertificate + + A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client. + + string + + + + KmipKeyServerHostnames + + Array of the hostnames or IP addresses associated with this KMIP Key Server. Multiple hostnames or IP addresses must only be provided if the key servers are in a clustered configuration. + + string + + + + KmipKeyServerName + + The name of the KMIP Key Server. This name is only used for display purposes and does not need to be unique. + + string + + + + KmipKeyServerPort + + The port number associated with this KMIP Key Server (typically 5696). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + KeyServerID + + The port number associated with this KMIP Key Server (typically 5696). + + int + + int + + + + + KmipCaCertificate + + The public key certificate of the external key server's root CA. This will be used to verify the certificate presented by external key server in the TLS communication. For key server clusters where individual servers use different CAs, provide a concatenated string containing the root certificates of all the CAs. + + string + + string + + + + + KmipClientCertificate + + A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client. + + string + + string + + + + + KmipKeyServerHostnames + + Array of the hostnames or IP addresses associated with this KMIP Key Server. Multiple hostnames or IP addresses must only be provided if the key servers are in a clustered configuration. + + string + + string + + + + + KmipKeyServerName + + The name of the KMIP Key Server. This name is only used for display purposes and does not need to be unique. + + string + + string + + + + + KmipKeyServerPort + + The port number associated with this KMIP Key Server (typically 5696). + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + CreateKeyServerKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFKeyServerKmip -KeyServerID 1 -KeyServerName "MyKeyServer" + + Set the name of Key Server with the specified ID + + + + + + + Set-SFLdapAuthentication + + [Cluster] Enables or disables LDAP configuration. + + + + + Set + SFLdapAuthentication + + + + [Cluster] Enables or disables LDAP configuration. + + + + Set-SFLdapAuthentication + + AuthType + + Identifies which user authentication method will be used. Must be one of the following: DirectBind, SearchAndBind. + + string + + + + GroupSearchBaseDN + + The base DN of the tree to start the group search. + + string + + + + GroupSearchType + + Controls the default group search filter used, must be one of the following: NoGroups, ActiveDirectory MemberDN. + + string + + + + ServerURIs + + An array of LDAP server URIs (examples: ldap://1.2.3.4 and ldaps://1.2.3.4:123) + + string[] + + + + UserSearchBaseDN + + The base DN of the tree to start the search. REQUIRED for SearchAndBind. + + string + + + + SearchBindDN + + A fully qualified DN to log in with to perform an LDAP search for the user. REQUIRED for SearchAndBind. + + string + + + + SearchBindPassword + + The password for the SearchBindDN account used for searching. REQUIRED for SearchAndBind. + + string + + + + UserSearchFilter + + The LDAP filter to use. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for SearchAndBind. + + string + + + + UserDNTemplate + + A string that will be used to form a fully qualified user DN. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for DirectBind. + + string + + + + GroupSearchCustomFilter + + For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a user's groups. The string can have placeholder text of %USERNAME% and %USERDN% to be replaced with their username and full userDN as needed. REQUIRED for CustomFilter. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Set-SFLdapAuthentication + + Disable + + Use this parameter to disable LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + AuthType + + Identifies which user authentication method will be used. Must be one of the following: DirectBind, SearchAndBind. + + string + + string + + + + + Disable + + Use this parameter to disable LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored. + + + switch + + + + + GroupSearchBaseDN + + The base DN of the tree to start the group search. + + string + + string + + + + + GroupSearchCustomFilter + + For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a user's groups. The string can have placeholder text of %USERNAME% and %USERDN% to be replaced with their username and full userDN as needed. REQUIRED for CustomFilter. + + string + + string + + + + + GroupSearchType + + Controls the default group search filter used, must be one of the following: NoGroups, ActiveDirectory MemberDN. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SearchBindDN + + A fully qualified DN to log in with to perform an LDAP search for the user. REQUIRED for SearchAndBind. + + string + + string + + + + + SearchBindPassword + + The password for the SearchBindDN account used for searching. REQUIRED for SearchAndBind. + + string + + string + + + + + ServerURIs + + An array of LDAP server URIs (examples: ldap://1.2.3.4 and ldaps://1.2.3.4:123) + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + UserDNTemplate + + A string that will be used to form a fully qualified user DN. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for DirectBind. + + string + + string + + + + + UserSearchBaseDN + + The base DN of the tree to start the search. REQUIRED for SearchAndBind. + + string + + string + + + + + UserSearchFilter + + The LDAP filter to use. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for SearchAndBind. + + string + + string + + + + + + + + System.String +System.String[] + + + + + + + + + + + + + LdapConfiguration + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LdapConfiguration.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFLdapAuthentication -Disable + + Disables the LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored. + + + + + + + Set-SFLicenseKey + + [Cluster] Sets the license key for the cluster + + + + + Set + SFLicenseKey + + + + [Cluster] Sets the current license key + + + + Set-SFLicenseKey + + OrderNumber + + The new sales order number for this cluster + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + OrderNumber + + The new sales order number for this cluster + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SerialNumber + + The new Serial Number for this cluster + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + SetLicenseKeyResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SetLicenseKey.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFLicenseKey -SerialNumber TestSN026 -OrderNumber xyz + + Sets the license key for the cluster + + + + + + + Set-SFLoginBanner + + [Cluster] Enables or disables the login banner and sets the banner text. + + + + + Set + SFLoginBanner + + + + [Cluster] Enables or disables the login banner and sets the banner text. + + + + Set-SFLoginBanner + + Banner + + The text to display in the login banner. + + string + + + + Enabled + + Enable the login banner display. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Set-SFLoginBanner + + Banner + + The text to display in the login banner. + + string + + + + Disabled + + Disable the login banner display. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Banner + + The text to display in the login banner. + + string + + string + + + + + Confirm + + + + + switch + + + + + Disabled + + Disable the login banner display. + + + switch + + + + + Enabled + + Enable the login banner display. + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFLoginBanner -Banner "Unauthorized use prohibited." -Enabled + + Sets the login banner text and enables the banner display. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFLoginBanner -Disabled + + Disables the login banner display. + + + + + + + Set-SFLoginSessionInfo + + [Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers. + + + + + Set + SFLoginSessionInfo + + + + [Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers. + + + + Set-SFLoginSessionInfo + + Timeout + + Cluster authentication expiration period. Formatted in HH:mm:ss. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Timeout + + Cluster authentication expiration period. Formatted in HH:mm:ss. + + string + + string + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + LoginSessionInfo + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoginSessionInfo.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFLoginSessionInfo -Timeout 00:35:00 + + Sets the timeout period to specified amount. + + + + + + + Set-SFLunAssignment + + [Cluster] Defines custom LUN assignments for specific volumes. + + + + + Set + SFLunAssignment + + + + [Cluster] Defines custom LUN assignments for specific volumes. + + + + Set-SFLunAssignment + + VolumeAccessGroupID + + Enter a volume access group ID + + long + + + + LunAssignment + + Enter a LunAssignment + + LunAssignment[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Set-SFLunAssignment + + VolumeAccessGroup + + Enter a volume access group + + VolumeAccessGroup + + + + LunAssignment + + Enter a LunAssignment + + LunAssignment[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + LunAssignment + + Enter a LunAssignment + + LunAssignment[] + + LunAssignment[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeAccessGroup + + Enter a volume access group + + VolumeAccessGroup + + VolumeAccessGroup + + + + + VolumeAccessGroupID + + Enter a volume access group ID + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +SolidFire.Element.Api.VolumeAccessGroup +SolidFire.Element.Api.LunAssignment[] + + + + + + + + + + + + + VolumeAccessGroupLunAssignments + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroupLunAssignments.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $vol25 = @{"VolumeID" = 25; "Lun" = 12} -Set-SFLunAssignment -VolumeAccessGroupID 5 -LunAssignment @( $vol25 ) - - Changes the LUN ID associated with volume ID 25 in volume access group 5 to "12". This example builds the hash table associated with the LUN assignments and then uses that variable in the cmdlet. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFLunAssignment -VolumeAccessGroupID 5 -LunAssignment @( @{"VolumeID" = 25; "Lun" = 12} ) - - Changes the LUN ID associated with volume ID 25 in volume access group 5 to 12. This example builds the hash table directly within the LUN assignments array. - - - - - - - Set-SFNetworkConfig - - [Node] Sets the network configuration options for a node. - - - - - Set - SFNetworkConfig - - - - [Node] Sets the network configuration options for a node. - - - - Address - - The IP address to set on the interface. Changing the IP Address on a node can cause a loss of network connectivity. Be prepared to reconnect if this command times out. - - string - - string - - - - - - BondMode - - The bond mode to set for the interface - - string - - string - - - - - - Confirm - - - - - switch - - - - - - DisconnectAfterRequest - - Include this switch parameter if you want to disconnect the connection immediately after the SetNetworkConfig request is made. - - - switch - - - - - - DnsNameservers - - The DNS nameservers to set on the interface - - string[] - - string[] - - - - - - DnsSearch - - The DNS search domains - - string[] - - string[] - - - - - - Gateway - - The gateway address to set on the interface - - string - - string - - - - - - Mtu - - The MTU to set on the interface. - - long - - long - - - - - - Netmask - - The Netmask to use for the interface - - string - - string - - - - - - Network - - The interface to set on. Must be one of 'Bond1G' | 'Bond10G'. Changing the BondMode on a node can cause a loss of network connectivity. Caution should be taken. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Status - - The interface status ('UpAndRunning' | 'Down' | 'Up') - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String -System.Int64 -System.String[] - - - - - [Node] Sets the network configuration options for a node. - - - - - - - - - - Network - http://solidfire.github.io/sdk-dotnet/help/v1.0/html/T_SolidFire_Element_Api_Network.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFNetworkConfig -Network Bond10G -Address 10.10.10.10 -Netmask 255.255.255.0 -Gateway 10.10.10.254 - - Sets a static IP address for the Bond10G interface on the node including specifying an optional gateway. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFNetworkConfig -Network Bond1G -Address 10.10.1.10 -Netmask 255.255.255.0 -Gateway 10.10.1.254 -DnsNameservers 10.10.100.1,10.10.100.2 -DnsSearch test.solidfire.net - - Sets a static IP address for the Bond1G interface on the node. This also specifies DNS servers and the DNS search domain. - - - - - - - Set-SFNtpInfo - - [Cluster] Configures the NTP on cluster nodes. - - - - - Set - SFNtpInfo - - - - [Cluster] Configures the NTP on cluster nodes. - - - - BroadcastClient - - Enable every node in the cluster as a broadcast client. Default is false. - - bool - - bool - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Servers - - List of NTP servers to add to each node's NTP configuration. - - string[] - - string[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.String[] -System.Boolean - - - - - [Cluster] Configures the NTP on cluster nodes. - - - - - - - - - - GetNtpInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetNtpInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFNtpInfo -Servers "time.nist.gov","time.windows.com" -BroadcastClient:$false - - Configures two NTP servers and turns off the broadcast client feature of NTP on the cluster. - - - - - - - Set-SFRemoteLoggingHost - - [Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers. - - - - - Set - SFRemoteLoggingHost - - - - [Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers. - - - - Confirm - - - - - switch - - - - - - RemoteHosts - - List of LoggingServer hosts to send log messages to. - - LoggingServer[] - - LoggingServer[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - SolidFire.Element.Api.LoggingServer[] - - - - - [Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers. - - - - - - - - - - LoggingServer[] - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoggingServer.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +Set-SFLunAssignment -VolumeAccessGroupID 5 -LunAssignment @( $vol25 ) + + Changes the LUN ID associated with volume ID 25 in volume access group 5 to "12". This example builds the hash table associated with the LUN assignments and then uses that variable in the cmdlet. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFLunAssignment -VolumeAccessGroupID 5 -LunAssignment @( @{"VolumeID" = 25; "Lun" = 12} ) + + Changes the LUN ID associated with volume ID 25 in volume access group 5 to 12. This example builds the hash table directly within the LUN assignments array. + + + + + + + Set-SFNetworkConfig + + [Node] Sets the network configuration options for a node. + + + + + Set + SFNetworkConfig + + + + [Node] Sets the network configuration options for a node. + + + + Set-SFNetworkConfig + + Network + + The interface to set on. Must be one of 'Bond1G' | 'Bond10G'. Changing the BondMode on a node can cause a loss of network connectivity. Caution should be taken. + + string + + + + BondMode + + The bond mode to set for the interface + + string + + + + Address + + The IP address to set on the interface. Changing the IP Address on a node can cause a loss of network connectivity. Be prepared to reconnect if this command times out. + + string + + + + Netmask + + The Netmask to use for the interface + + string + + + + Gateway + + The gateway address to set on the interface + + string + + + + Mtu + + The MTU to set on the interface. + + long + + + + DnsNameservers + + The DNS nameservers to set on the interface + + string[] + + + + DnsSearch + + The DNS search domains + + string[] + + + + Status + + The interface status ('UpAndRunning' | 'Down' | 'Up') + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Address + + The IP address to set on the interface. Changing the IP Address on a node can cause a loss of network connectivity. Be prepared to reconnect if this command times out. + + string + + string + + + + + BondMode + + The bond mode to set for the interface + + string + + string + + + + + Confirm + + + + + switch + + + + + DisconnectAfterRequest + + Include this switch parameter if you want to disconnect the connection immediately after the SetNetworkConfig request is made. + + + switch + + + + + DnsNameservers + + The DNS nameservers to set on the interface + + string[] + + string[] + + + + + DnsSearch + + The DNS search domains + + string[] + + string[] + + + + + Gateway + + The gateway address to set on the interface + + string + + string + + + + + Mtu + + The MTU to set on the interface. + + long + + long + + + + + Netmask + + The Netmask to use for the interface + + string + + string + + + + + Network + + The interface to set on. Must be one of 'Bond1G' | 'Bond10G'. Changing the BondMode on a node can cause a loss of network connectivity. Caution should be taken. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Status + + The interface status ('UpAndRunning' | 'Down' | 'Up') + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String +System.Int64 +System.String[] + + + + + + + + + + + + + Network + http://solidfire.github.io/sdk-dotnet/help/v1.0/html/T_SolidFire_Element_Api_Network.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFNetworkConfig -Network Bond10G -Address 10.10.10.10 -Netmask 255.255.255.0 -Gateway 10.10.10.254 + + Sets a static IP address for the Bond10G interface on the node including specifying an optional gateway. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFNetworkConfig -Network Bond1G -Address 10.10.1.10 -Netmask 255.255.255.0 -Gateway 10.10.1.254 -DnsNameservers 10.10.100.1,10.10.100.2 -DnsSearch test.solidfire.net + + Sets a static IP address for the Bond1G interface on the node. This also specifies DNS servers and the DNS search domain. + + + + + + + Set-SFNodeSSLCertificate + + [Node] Sets the management node's SSL certificate. + + + + + Set + SFNodeSSLCertificate + + + + [Node] Sets the management node's SSL certificate. + + + + Set-SFNodeSSLCertificate + + Certificate + + Certificate string + + string + + + + PrivateKey + + Private key string + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Certificate + + Certificate string + + string + + string + + + + + Confirm + + + + + switch + + + + + PrivateKey + + Private key string + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFNodeSSLCertificate -Certificate $cert_string -PrivateKey $key_string -Confirm:$false + + Sets the management node's SSL certificate using certificate and key strings previously assigned to variables. + + + + + + + Set-SFNodeSupplementalTlsCiphers + + [Node] Set the list of supplemental TLS ciphers for a node. + + + + + Set + SFNodeSupplementalTlsCiphers + + + + [Node] Set the list of supplemental TLS ciphers for a node. + + + + Set-SFNodeSupplementalTlsCiphers + + SupplementalCiphers + + [Node] The supplemental cipher suite names using the OpenSSL naming scheme. Use of cipher suite names is case-insensitive. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SupplementalCiphers + + [Node] The supplemental cipher suite names using the OpenSSL naming scheme. Use of cipher suite names is case-insensitive. + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String[] + + + + + + + + + + + + + SetNodeSupplementalTlsCiphersResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + "DHE-RSA-AES128-SHA256" | Set-SFNodeSupplementalTlsCiphers + + Enables a supplemental Tls cipher + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + (Get-SFNodeSupportedTlsCiphers).SupportedSupplementalCiphers | Set-SFNodeSupplementalTlsCiphers + + Enables all supported supplemental Tls ciphers + + + + + + + Set-SFNtpInfo + + [Cluster] Configures the NTP on cluster nodes. + + + + + Set + SFNtpInfo + + + + [Cluster] Configures the NTP on cluster nodes. + + + + Set-SFNtpInfo + + Servers + + List of NTP servers to add to each node's NTP configuration. + + string[] + + + + BroadcastClient + + Enable every node in the cluster as a broadcast client. Default is false. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + BroadcastClient + + Enable every node in the cluster as a broadcast client. Default is false. + + bool + + bool + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Servers + + List of NTP servers to add to each node's NTP configuration. + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String[] +System.Boolean + + + + + + + + + + + + + GetNtpInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetNtpInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFNtpInfo -Servers "time.nist.gov","time.windows.com" -BroadcastClient:$false + + Configures two NTP servers and turns off the broadcast client feature of NTP on the cluster. + + + + + + + Set-SFProtectionDomainLayout + + [Cluster] Used to assign Nodes to user-defined Protection Domains. This information must be provided for all Active Nodes in the cluster, and no information may be provided for Nodes that are not Active. All Nodes in a given Chassis must be assigned to the same user-defined Protection Domain. The same ProtectionDomainType must be supplied for all nodes. ProtectionDomainTypes that are not user-defined such as Node and Chassis, must not be included. If any of these are not true, the Custom Protection Domains will be ignored, and an appropriate error will be returned. + + + + + Set + SFProtectionDomainLayout + + + + [Cluster] Used to assign Nodes to user-defined Protection Domains. This information must be provided for all Active Nodes in the cluster, and no information may be provided for Nodes that are not Active. All Nodes in a given Chassis must be assigned to the same user-defined Protection Domain. The same ProtectionDomainType must be supplied for all nodes. ProtectionDomainTypes that are not user-defined such as Node and Chassis, must not be included. If any of these are not true, the Custom Protection Domains will be ignored, and an appropriate error will be returned. + + + + Set-SFProtectionDomainLayout + + ProtectionDomainLayout + + The Protection Domains for each Node. + + NodeProtectionDomains[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ProtectionDomainLayout + + The Protection Domains for each Node. + + NodeProtectionDomains[] + + NodeProtectionDomains[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + SolidFire.Element.Api.NodeProtectionDomains[] + + + + + + + + + + + + + NodeProtectionDomains[] + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + $nodeProtectionDomain = New-Object SolidFire.Element.Api.NodeProtectionDomains; $protectionDomain = New-Object SolidFire.Element.Api.ProtectionDomain; $protectionDomain.ProtectionDomainName = "70L0K02"; $protectionDomain.ProtectionDomainType = "Custom"; $nodeProtectionDomain.NodeID = 1; $nodeProtectionDomain.ProtectionDomains = @($protectionDomain); Set-SFProtectionDomainLayout -ProtectionDomainLayout @($nodeProtectionDomain); + + Assigns Node with ID 1 to user-defined Protection Domain Custom + + + + + + + Set-SFQoSPolicy + + Modifies an existing QoS Policy. + + + + + Set + SFQoSPolicy + + + + Modifies an existing QoS Policy. Any volumes associated with the policy will inherit any changes to the policy's IOPS settings. + + + + Set-SFQoSPolicy + + QoSPolicyID + + The ID of the QoS policy to modify + + int + + + + Name + + The name of the QoS policy + + string + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + int + + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + int + + + + + Confirm + + + + + switch + + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + int + + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + int + + + + + Name + + The name of the QoS policy + + string + + string + + + + + QoSPolicyID + + The ID of the QoS policy to modify + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int32 +System.String + + + + + + + + + + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFQoSPolicy -QoSPolicyID 33 -BurstIOPS 150000 + + Modifies the QoS Policy with ID 33 to have a BurstIOPS value of 150000. + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFQoSPolicy -QoSPolicyID 33 -Name "Green" + + Sets the name of the QoS Policy with ID 33 to "Green". + + + + + + + Set-SFRemoteLoggingHost + + [Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers. + + + + + Set + SFRemoteLoggingHost + + + + [Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers. + + + + Set-SFRemoteLoggingHost + + RemoteHosts + + List of LoggingServer hosts to send log messages to. + + LoggingServer[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + RemoteHosts + + List of LoggingServer hosts to send log messages to. + + LoggingServer[] + + LoggingServer[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + SolidFire.Element.Api.LoggingServer[] + + + + + + + + + + + + + LoggingServer[] + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoggingServer.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $rh = Get-SFRemoteLoggingHost -Set-SFRemoteLoggingHost -RemoteHosts $rh -Confirm:$false - - Sets the RemoteLoggingHost with a LoggingServer with no confirmation prompt. - - - - - - - Set-SFSchedule - - [Cluster] Modifies a schedule which creates a snapshot of a volume. - - - - - Set - SFSchedule - - - - [Cluster] Modifies a schedule which creates a snapshot of a volume. - - - - EnableRemoteReplication - - Include snapshots in replication when paired. Default is false. - - bool - - bool - - - - - - Frequency - - Used to indicate the frequency at which the snapshot will be made. - - string - - string - - - - - - Paused - - Use to pause the schedule. - - bool - - bool - - - - - - Recurring - - Indicates if the schedule will be recurring or not. Default is true. - - bool - - bool - - - - - - RetentionDays - - Number of days to retain snapshots created by this schedule. - - uint64 - - uint64 - - - - - - RetentionHours - - Number of hours to retain snapshots created by this schedule. - - uint64 - - uint64 - - - - - - RetentionMinutes - - Number of minutes to retain snapshots created by this schedule. - - uint64 - - uint64 - - - - - - RunNextInterval - - Choose to run this Schedule the next time the scheduler is active. - - bool - - bool - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - ScheduleID - - Unique ID of the schedule. - - long[] - - long[] - - - - - - ScheduleName - - Unique name for the schedule. - - string - - string - - - - - - SnapshotName - - Name of the new snapshot. - - string - - string - - - - - - StartingDate - - Date/Time after which the schedule will be run. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - ToBeDeleted - - Indicates if the schedule is marked for deletion. - - bool - - bool - - - - - - VolumeID - - Volume IDs to be included in the resulting snapshots. VolumeID values will replace ScheduleInfo.Volume values if an existing Schedule is piped in. - - long[] - - long[] - - - - - - - - - System.Int64[] - - - - - [Cluster] Modifies a schedule which creates a snapshot of a volume. - - - - - - - - - - Schedule - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFSchedule -ScheduleID 4 -ScheduleName newName -VolumeID 8 - - Sets specified schedule's name to "newName" and changes which volume it targets. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFSchedule -ScheduleID 13 -Frequency DaysOfMonth -DaysOfMonthDays 1,15 - +Set-SFRemoteLoggingHost -RemoteHosts $rh -Confirm:$false + + Sets the RemoteLoggingHost with a LoggingServer with no confirmation prompt. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + $server = @{"Host" = "10.192.2.131"; "Port" = 514;} +Set-SFRemoteLoggingHost -RemoteHosts $server -Confirm:$false + + Sets the RemoteLoggingHost with a LoggingServer with no confirmation prompt. + + + + + + + Set-SFSchedule + + [Cluster] Modifies a schedule which creates a snapshot of a volume. + + + + + Set + SFSchedule + + + + [Cluster] Modifies a schedule which creates a snapshot of a volume. + + + + Set-SFSchedule + + ScheduleID + + Unique ID of the schedule. + + long[] + + + + VolumeID + + Volume IDs to be included in the resulting snapshots. VolumeID values will replace ScheduleInfo.Volume values if an existing Schedule is piped in. + + long[] + + + + ScheduleName + + Unique name for the schedule. + + string + + + + Frequency + + Used to indicate the frequency at which the snapshot will be made. + + string + + + + ToBeDeleted + + Indicates if the schedule is marked for deletion. + + bool + + + + Paused + + Use to pause the schedule. + + bool + + + + RunNextInterval + + Choose to run this Schedule the next time the scheduler is active. + + bool + + + + SnapshotName + + Name of the new snapshot. + + string + + + + Recurring + + Indicates if the schedule will be recurring or not. Default is true. + + bool + + + + EnableRemoteReplication + + Include snapshots in replication when paired. Default is false. + + bool + + + + RetentionDays + + Number of days to retain snapshots created by this schedule. + + ulong + + + + RetentionHours + + Number of hours to retain snapshots created by this schedule. + + ulong + + + + RetentionMinutes + + Number of minutes to retain snapshots created by this schedule. + + ulong + + + + StartingDate + + Date/Time after which the schedule will be run. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + EnableRemoteReplication + + Include snapshots in replication when paired. Default is false. + + bool + + bool + + + + + Frequency + + Used to indicate the frequency at which the snapshot will be made. + + string + + string + + + + + Paused + + Use to pause the schedule. + + bool + + bool + + + + + Recurring + + Indicates if the schedule will be recurring or not. Default is true. + + bool + + bool + + + + + RetentionDays + + Number of days to retain snapshots created by this schedule. + + ulong + + ulong + + + + + RetentionHours + + Number of hours to retain snapshots created by this schedule. + + ulong + + ulong + + + + + RetentionMinutes + + Number of minutes to retain snapshots created by this schedule. + + ulong + + ulong + + + + + RunNextInterval + + Choose to run this Schedule the next time the scheduler is active. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + ScheduleID + + Unique ID of the schedule. + + long[] + + long[] + + + + + ScheduleName + + Unique name for the schedule. + + string + + string + + + + + SnapshotName + + Name of the new snapshot. + + string + + string + + + + + StartingDate + + Date/Time after which the schedule will be run. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + ToBeDeleted + + Indicates if the schedule is marked for deletion. + + bool + + bool + + + + + VolumeID + + Volume IDs to be included in the resulting snapshots. VolumeID values will replace ScheduleInfo.Volume values if an existing Schedule is piped in. + + long[] + + long[] + + + + + + + + System.Int64[] + + + + + + + + + + + + + Schedule + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSchedule -ScheduleID 4 -ScheduleName newName -VolumeID 8 + + Sets specified schedule's name to "newName" and changes which volume it targets. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFSchedule -ScheduleID 13 -Frequency DaysOfMonth -DaysOfMonthDays 1,15 + Sets schedule with ID 13 to run the 1st and 15tht of the month. -NOTE: parameter "DaysOfMonthDays" will only appear if "DaysOfMonth" has already been chosen. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Set-SFSchedule -ScheduleID 14 -Frequency DaysOfWeek -DaysOfWeekDays Monday,Friday -RunNextInterval:$true -RetentionDays 120 - +NOTE: parameter "DaysOfMonthDays" will only appear if "DaysOfMonth" has already been chosen. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Set-SFSchedule -ScheduleID 14 -Frequency DaysOfWeek -DaysOfWeekDays Monday,Friday -RunNextInterval:$true -RetentionDays 120 + Sets schedule with ID 14 to run on Monday and Friday. Also sets it to run on the next interval anSd sets the retention to 120 days. -NOTE: parameter "DaysOfWeekDays" will only appear if "DaysOfWeek" has already been chosen. - - - - -------------------------- EXAMPLE 4 -------------------------- - - PS C:\> - - Set-SFSchedule -ScheduleID 15 -Frequency TimeInterval -TimeIntervalDays 1 -StartingDate 2017-06-05T12:22:40 - +NOTE: parameter "DaysOfWeekDays" will only appear if "DaysOfWeek" has already been chosen. + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Set-SFSchedule -ScheduleID 15 -Frequency TimeInterval -TimeIntervalDays 1 -StartingDate 2017-06-05T12:22:40 + Sets schedule with ID 15 to a TimeInterval of 1 day and also sets the starting date. -NOTE: parameters "TimeIntervalDays","TimeIntervalHours", and "TimeIntervalMinutes" will only appear if "TimeInterval" has already been chosen. - - - - - - - Set-SFSnapshot - - [Cluster] Modifies a point-in-time snapshot of a volume. - - - - - Set - SFSnapshot - - - - [Cluster] Modifies a point-in-time snapshot of a volume. - - - - Confirm - - - - - switch - - - - - - EnableRemoteReplication - - Use to enable the snapshot created to be replicated to a remote SolidFire cluster. - - bool - - bool - - - - - - ExpirationTime - - Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - ID(s) of the snapshots to modify. - - long[] - - long[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Modifies a point-in-time snapshot of a volume. - - - - - - - - - - Snapshot - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm - - - - - Set-SFSnapshot is used to change the attributes currently assigned to a snapshot. Use this API method to enable the snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system. - - - None - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFSnapshot -SnapshotID 4 -EnableRemoteReplication $true - - EnableRemoteReplication on Snapshot with specified ID. In this case, SnapshotID: 4. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFSnapshot -SnapshotID 4 -ExpirationTime 2017-12-30T12:30:45 - - Sets specified snapshot to be removed at given ISO-8601 time. - - - - - - - Set-SFSnmpAcl - - [Cluster] Configures SNMP access permissions on the cluster node. - - - - - Set - SFSnmpAcl - - - - [Cluster] Configures SNMP access permissions on the cluster node. - - - - Confirm - - - - - switch - - - - - - Networks - - List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only. - - SnmpNetwork[] - - SnmpNetwork[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - UsmUsers - - If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only. - - SnmpV3UsmUser[] - - SnmpV3UsmUser[] - - - - - - WhatIf - - - - - switch - - - - - - - - - SolidFire.Element.Api.SnmpNetwork[] -SolidFire.Element.Api.SnmpV3UsmUser[] - - - - - [Cluster] Configures SNMP access permissions on the cluster node. - - - - - - - - - - GetSnmpACLResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +NOTE: parameters "TimeIntervalDays","TimeIntervalHours", and "TimeIntervalMinutes" will only appear if "TimeInterval" has already been chosen. + + + + + + + Set-SFSnapMirrorEndpoint + + [Cluster] Set-SFSnapMirrorEndpoint changes the name and management attributes for a SnapMirror endpoint. + + + + + Set + SFSnapMirrorEndpoint + + + + [Cluster] Set-SFSnapMirrorEndpoint changes the name and management attributes for a SnapMirror endpoint. + + + + Set-SFSnapMirrorEndpoint + + SnapMirrorEndpointID + + The SnapMirror endpoint to modify. + + long + + + + ManagementIP + + The new management IP Address for the ONTAP system. + + string + + + + Username + + The new management username for the ONTAP system. + + string + + + + Password + + The new management password for the ONTAP system. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ManagementIP + + The new management IP Address for the ONTAP system. + + string + + string + + + + + Password + + The new management password for the ONTAP system. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The SnapMirror endpoint to modify. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + The new management username for the ONTAP system. + + string + + string + + + + + + + + None + + + + + + + + + + + + + ModifySnapMirrorEndpointResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifySnapMirrorEndpointResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSnapMirrorEndpoint -SnapMirrorEndpointID 5 -ManagementIP 5.4.3.2 -Username admin -Password admin + + Updates the management IP, username, and password for endpoint 5. NOTE: IP must point towards management node, and credentials must be correct for ONTAP device. This command is primarily used for updating the element side endpoint settings if they are changed on the ONTAP side. + + + + + + + Set-SFSnapMirrorEndpointUnmanaged + + [Cluster] Set-SFSnapMirrorEndpointUnmanaged modifies a SnapMirror endpoint. + + + + + Set + SFSnapMirrorEndpointUnmanaged + + + + [Cluster] The Set-SFSnapMirrorEndpointUnmanaged cmdlet changes the name and/or management attributes for a SnapMirror endpoint. + + + + Set-SFSnapMirrorEndpointUnmanaged + + SnapMirrorEndpointID + + The SnapMirror endpoint to modify. + + long + + + + ClusterName + + Name of the endpoint. + + string + + + + IpAddresses + + The new list of IP addresses for a cluster of ONTAP storage systems that should communicate with this SolidFire cluster. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ClusterName + + Name of the endpoint. + + string + + string + + + + + IpAddresses + + The new list of IP addresses for a cluster of ONTAP storage systems that should communicate with this SolidFire cluster. + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The SnapMirror endpoint to modify. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ModifySnapMirrorEndpointUnmanagedResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifySnapMirrorEndpointUnmanagedResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSnapMirrorEndpointUnmanaged -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -ClusterName "New Name" -IpAddresses "2.2.2.2","3.3.3.3" + + Sets a specific endpoints name and IP addresses. + + + + + + + Set-SFSnapMirrorRelationship + + [Cluster] Set-SFSnapMirrorRelationship changes the intervals at which a scheduled snapshot occurs, along with other settings. You can also delete or pause a schedule by using this method. + + + + + Set + SFSnapMirrorRelationship + + + + [Cluster] Set-SFSnapMirrorRelationship changes the intervals at which a scheduled snapshot occurs. You can also delete or pause a schedule by using this method. + + + + Set-SFSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + + + PolicyName + + Specifies the name of the ONTAP SnapMirror policy for the relationship. + + string + + + + ScheduleName + + The name of the pre-existing cron schedule on the ONTAP system that is used to update the SnapMirror relationship. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + long + + + + + PolicyName + + Specifies the name of the ONTAP SnapMirror policy for the relationship. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + ScheduleName + + The name of the pre-existing cron schedule on the ONTAP system that is used to update the SnapMirror relationship. + + string + + string + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ModifySnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifySnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeVserver $vserverName -DestinationVolumeName $snapMirrorVolume.Name -ScheduleName "daily" + + Sets the schedule of the relationship to daily. + + + + + + + Set-SFSnapshot + + [Cluster] Modifies a point-in-time snapshot of a volume. + + + + + Set + SFSnapshot + + + + [Cluster] Modifies a point-in-time snapshot of a volume. + + + + Set-SFSnapshot + + SnapshotID + + ID(s) of the snapshots to modify. + + long[] + + + + EnableRemoteReplication + + Use to enable the snapshot created to be replicated to a remote SolidFire cluster. + + bool + + + + ExpirationTime + + Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + EnableRemoteReplication + + Use to enable the snapshot created to be replicated to a remote SolidFire cluster. + + bool + + bool + + + + + ExpirationTime + + Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + ID(s) of the snapshots to modify. + + long[] + + long[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] + + + + + + + + + + + + + Snapshot + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm + + + + + Set-SFSnapshot is used to change the attributes currently assigned to a snapshot. Use this API method to enable the snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system. + + + None + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSnapshot -SnapshotID 4 -EnableRemoteReplication $true + + EnableRemoteReplication on Snapshot with specified ID. In this case, SnapshotID: 4. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFSnapshot -SnapshotID 4 -ExpirationTime 2017-12-30T12:30:45 + + Sets specified snapshot to be removed at given ISO-8601 time. + + + + + + + Set-SFSnmpAcl + + [Cluster] Configures SNMP access permissions on the cluster node. + + + + + Set + SFSnmpAcl + + + + [Cluster] Configures SNMP access permissions on the cluster node. + + + + Set-SFSnmpAcl + + Networks + + List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only. + + SnmpNetwork[] + + + + UsmUsers + + If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only. + + SnmpV3UsmUser[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Networks + + List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only. + + SnmpNetwork[] + + SnmpNetwork[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + UsmUsers + + If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only. + + SnmpV3UsmUser[] + + SnmpV3UsmUser[] + + + + + WhatIf + + + + + switch + + + + + + + + SolidFire.Element.Api.SnmpNetwork[] +SolidFire.Element.Api.SnmpV3UsmUser[] + + + + + + + + + + + + + GetSnmpACLResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $newAcl = Add-SFSnmpUsmUser -Access "rouser" -Name "testuser" -Password "testpass" -Passphrase "testphrase" -SecLevel "noauth" -Set-SFSnmpAcl -UsmUser $newAcl - - Adds a new USM user to the SNMPv3 configuration on the cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Set-SFSnmpAcl -UsmUser $newAcl + + Adds a new USM user to the SNMPv3 configuration on the cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $newAcl = Add-SFSnmpNetwork -Access "ro" -Cidr 1 -Community "Community" -Network "network" -Set-SFSnmpAcl -Networks $newAcl - - Adds a single new network to the SNMP configuration on the cluster. - - - - - - - Set-SFSnmpInfo - - [Cluster] Configures SNMP v2 and v3 on the cluster nodes. - - - - - Set - SFSnmpInfo - - - - [Cluster] Configures SNMP v2 and v3 on the cluster nodes. - - - - Confirm - - - - - switch - - - - - - Enabled - - If set to 'true', then SNMP is enabled on each node in the cluster. - - bool - - bool - - - - - - Networks - - List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only. - - SnmpNetwork[] - - SnmpNetwork[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnmpV3Enabled - - If set to 'true', then SNMP v3 is enabled on each node in the cluster. - - bool - - bool - - - - - - Target - - - - string[] - - string[] - - - - - - UsmUsers - - If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only. - - SnmpV3UsmUser[] - - SnmpV3UsmUser[] - - - - - - WhatIf - - - - - switch - - - - - - - - - SolidFire.Element.Api.SnmpNetwork[] -System.Boolean -SolidFire.Element.Api.SnmpV3UsmUser[] - - - - - [Cluster] Configures SNMP v2 and v3 on the cluster nodes. - - - - - - - - - - GetSnmpInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +Set-SFSnmpAcl -Networks $newAcl + + Adds a single new network to the SNMP configuration on the cluster. + + + + + + + Set-SFSnmpInfo + + [Cluster] Configures SNMP v2 and v3 on the cluster nodes. + + + + + Set + SFSnmpInfo + + + + [Cluster] Configures SNMP v2 and v3 on the cluster nodes. + + + + Set-SFSnmpInfo + + Networks + + List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only. + + SnmpNetwork[] + + + + Enabled + + If set to 'true', then SNMP is enabled on each node in the cluster. + + bool + + + + SnmpV3Enabled + + If set to 'true', then SNMP v3 is enabled on each node in the cluster. + + bool + + + + UsmUsers + + If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only. + + SnmpV3UsmUser[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Enabled + + If set to 'true', then SNMP is enabled on each node in the cluster. + + bool + + bool + + + + + Networks + + List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only. + + SnmpNetwork[] + + SnmpNetwork[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnmpV3Enabled + + If set to 'true', then SNMP v3 is enabled on each node in the cluster. + + bool + + bool + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + UsmUsers + + If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only. + + SnmpV3UsmUser[] + + SnmpV3UsmUser[] + + + + + WhatIf + + + + + switch + + + + + + + + SolidFire.Element.Api.SnmpNetwork[] +System.Boolean +SolidFire.Element.Api.SnmpV3UsmUser[] + + + + + + + + + + + + + GetSnmpInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $n = Get-SFSnmpInfo -Set-SFSnmpInfo -Network $n.Networks -Enabled:$true -Confirm:$false - - Sets SNMP to enabled on all networks with no confirmation prompt. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Set-SFSnmpInfo -Network $n.Networks -Enabled:$true -Confirm:$false + + Sets SNMP to enabled on all networks with no confirmation prompt. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $n = Get-SFSnmpInfo $user = Add-SFSnmpUsmUser -Name admin -Access rouser -Password password -Passphrase passphrase -SecLevel auth -Set-SFSnmpInfo -Networks $n.Networks -Enabled:$true -SnmpV3Enabled:$true -UsmUsers $user.UsmUsers -Confirm:$false - - Creates a UsmUser. Sets SNMPv3 to enabled on all networks and passes the recently created UsmUser with no confirmation prompt. - - - - - - - Set-SFSnmpTrapInfo - - [Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications. - - - - - Set - SFSnmpTrapInfo - - - - [Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications. - - - - ClusterEventTrapsEnabled - - If set to true, a corresponding solidFireClusterEventNotification is sent to the configured list of trap recipients when a cluster event is logged. - - bool - - bool - - - - - - ClusterFaultResolvedTrapsEnabled - - If set to true, a corresponding solidFireClusterFaultResolvedNotification is sent to the configured list of trap recipients when a cluster fault is resolved. - - bool - - bool - - - - - - ClusterFaultTrapsEnabled - - If set to true, a corresponding solidFireClusterFaultNotification is sent to the configured list of trap recipients when a cluster fault is logged. - - bool - - bool - - - - - - Confirm - - - - - switch - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - TrapRecipients - - List of hosts that are to receive the traps generated by the Cluster Master. At least one object is required if any one of the trap types is enabled. - - SnmpTrapRecipient[] - - SnmpTrapRecipient[] - - - - - - WhatIf - - - - - switch - - - - - - - - - SolidFire.Element.Api.SnmpTrapRecipient[] -System.Boolean - - - - - [Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications. - - - - - - - - - - SFSnmpTrapInfoResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFSnmpTrapInfo -TrapRecipients "10.11.12.13","14.15.16.17" -ClusterFaultTrapsEnabled:$true -ClusterFaultResolvedTrapsEnabled:$true -ClusterEventTrapsEnabled:$false - - - - - - - - - Set-SFStorageContainer - - Modifies an existing storage container. - - - - - Set - SFStorageContainer - - - - Modifies an existing storage container. - - - - InitiatorSecret - - The secret for CHAP authentication for the initiator - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - StorageContainerID - - The ID of the storage container you wish to update. - - guid - - guid - - - - - - Target - - - - string[] - - string[] - - - - - - TargetSecret - - The secret for CHAP authentication for the target - - string - - string - - - - - - - - - System.Guid - - - - - Modifies an existing storage container. - - - - - - - Modifies an existing storage container. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +Set-SFSnmpInfo -Networks $n.Networks -Enabled:$true -SnmpV3Enabled:$true -UsmUsers $user.UsmUsers -Confirm:$false + + Creates a UsmUser. Sets SNMPv3 to enabled on all networks and passes the recently created UsmUser with no confirmation prompt. + + + + + + + Set-SFSnmpTrapInfo + + [Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications. + + + + + Set + SFSnmpTrapInfo + + + + [Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications. + + + + Set-SFSnmpTrapInfo + + TrapRecipients + + List of hosts that are to receive the traps generated by the Cluster Master. At least one object is required if any one of the trap types is enabled. + + SnmpTrapRecipient[] + + + + ClusterFaultTrapsEnabled + + If set to true, a corresponding solidFireClusterFaultNotification is sent to the configured list of trap recipients when a cluster fault is logged. + + bool + + + + ClusterFaultResolvedTrapsEnabled + + If set to true, a corresponding solidFireClusterFaultResolvedNotification is sent to the configured list of trap recipients when a cluster fault is resolved. + + bool + + + + ClusterEventTrapsEnabled + + If set to true, a corresponding solidFireClusterEventNotification is sent to the configured list of trap recipients when a cluster event is logged. + + bool + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + ClusterEventTrapsEnabled + + If set to true, a corresponding solidFireClusterEventNotification is sent to the configured list of trap recipients when a cluster event is logged. + + bool + + bool + + + + + ClusterFaultResolvedTrapsEnabled + + If set to true, a corresponding solidFireClusterFaultResolvedNotification is sent to the configured list of trap recipients when a cluster fault is resolved. + + bool + + bool + + + + + ClusterFaultTrapsEnabled + + If set to true, a corresponding solidFireClusterFaultNotification is sent to the configured list of trap recipients when a cluster fault is logged. + + bool + + bool + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TrapRecipients + + List of hosts that are to receive the traps generated by the Cluster Master. At least one object is required if any one of the trap types is enabled. + + SnmpTrapRecipient[] + + SnmpTrapRecipient[] + + + + + WhatIf + + + + + switch + + + + + + + + SolidFire.Element.Api.SnmpTrapRecipient[] +System.Boolean + + + + + + + + + + + + + SFSnmpTrapInfoResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSnmpTrapInfo -TrapRecipients "10.11.12.13","14.15.16.17" -ClusterFaultTrapsEnabled:$true -ClusterFaultResolvedTrapsEnabled:$true -ClusterEventTrapsEnabled:$false + + + + + + + + + Set-SFSoftwareEncryptionAtRestMasterKey + + [Cluster] Rekey the Software Encryption At Rest Master Key used to encrypt the DEKs (Data Encryption Keys). + + + + + Set + SFSoftwareEncryptionAtRestMasterKey + + + + [Cluster] Rekey the Software Encryption At Rest Master Key used to encrypt the DEKs (Data Encryption Keys). + + + + Set-SFSoftwareEncryptionAtRestMasterKey + + KeyManagementType + + The type of Key Management used to manage the Master Key. Possible values are: Internal: Rekey using Internal Key Management., External: Rekey using External Key Management. + + string + + + + KeyProviderID + + The ID of the Key Provider to use. This is a unique value returned as part of one of the CreateKeyProvider* methods. Required when keyManagementType is "External", invalid otherwise. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyManagementType + + The type of Key Management used to manage the Master Key. Possible values are: Internal: Rekey using Internal Key Management., External: Rekey using External Key Management. + + string + + string + + + + + KeyProviderID + + The ID of the Key Provider to use. This is a unique value returned as part of one of the CreateKeyProvider* methods. Required when keyManagementType is "External", invalid otherwise. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + RekeySoftwareEncryptionAtRestMasterKeyResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RekeySoftwareEncryptionAtRestMasterKeyResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSoftwareEncryptionAtRestMasterKey + + Rekeys the Software Encryption At Rest Master Key + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFSoftwareEncryptionAtRestMasterKey -KeyManagementType "Internal" + + Rekeys the Software Encryption At Rest Master Key using Internal Key Management + + + + + + + Set-SFSSLCertificate + + [Cluster] Sets the cluster's SSL certificate. + + + + + Set + SFSSLCertificate + + + + [Cluster] Sets the cluster's SSL certificate. + + + + Set-SFSSLCertificate + + Certificate + + Certificate string + + string + + + + PrivateKey + + Private key string + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Certificate + + Certificate string + + string + + string + + + + + Confirm + + + + + switch + + + + + PrivateKey + + Private key string + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String + + + + + + + + + + + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFSSLCertificate -Certificate $cert_string -PrivateKey $key_string -Confirm:$false + + Sets the cluster's SSL certificate using certificate and key strings previously assigned to variables. + + + + + + + Set-SFStorageContainer + + Modifies an existing storage container. + + + + + Set + SFStorageContainer + + + + Modifies an existing storage container. + + + + Set-SFStorageContainer + + StorageContainerID + + The ID of the storage container you wish to update. + + guid + + + + InitiatorSecret + + The secret for CHAP authentication for the initiator + + string + + + + TargetSecret + + The secret for CHAP authentication for the target + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + InitiatorSecret + + The secret for CHAP authentication for the initiator + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + StorageContainerID + + The ID of the storage container you wish to update. + + guid + + guid + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TargetSecret + + The secret for CHAP authentication for the target + + string + + string + + + + + + + + System.Guid + + + + + + + + + + Modifies an existing storage container. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $containers = Get-SFStorageContainer -Set-SFStorageContainer -StorageContainerID $containers[3].StorageContainerID -InitiatorSecret abc123def567 -TargetSecret xyz246wasd678 - - Sets the InitiatorSecret and TargetSecret of the specified Storage Container. - - - - - - - Set-SFVirtualNetwork - - [Cluster] Modifies various attributes of a VirtualNetwork object. - - - - - Set - SFVirtualNetwork - - - - [Cluster] Modifies various attributes of a VirtualNetwork object. - - - - AddressBlocks - - New addressBlock to set for this Virtual Network object. This may contain new address blocks to add to the existing object or it may omit unused address blocks that need to be removed. Alternatively, existing address blocks may be extended or reduced in size. The size of the starting addressBlocks for a Virtual Network object. - - AddressBlock[] - - AddressBlock[] - - - - - - Attributes - - A new list of Name/Value pairs in JSON object format. - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - Name - - New name for the network. - - string - - string - - - - - - Netmask - - New netmask for this virtual network. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Svip - - The storage virtual IP address for this virtual network. The svip for Virtual Network cannot be changed. A new Virtual Network must be created in order to use a different svip address. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualNetworkID - - Unique identifier of the virtual network to modify. - - long - - long - - - - - - VirtualNetworkTag - - A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported). - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String -SolidFire.Element.Api.AddressBlock[] - - - - - [Cluster] Modifies various attributes of a VirtualNetwork object. - - - - - - - The modified VirtualNetwork object. - - - VirtualNetwork - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFVirtualNetwork -VirtualNetworkID 5 -Name "NewName" - - Changes the name of an existing virtual network. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Set-SFStorageContainer -StorageContainerID $containers[3].StorageContainerID -InitiatorSecret abc123def567 -TargetSecret xyz246wasd678 + + Sets the InitiatorSecret and TargetSecret of the specified Storage Container. + + + + + + + Set-SFSupplementalTlsCiphers + + [Node] Set the list of supplemental TLS ciphers. + + + + + Set + SFSupplementalTlsCiphers + + + + [Node] Set the list of supplemental TLS ciphers. + + + + Set-SFSupplementalTlsCiphers + + SupplementalCiphers + + The supplemental cipher suite names using the OpenSSL naming scheme. Use of cipher suite names is case-insensitive. + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SupplementalCiphers + + The supplemental cipher suite names using the OpenSSL naming scheme. Use of cipher suite names is case-insensitive. + + string[] + + string[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + System.String[] + + + + + + + + + + + + + SetNodeSupplementalTlsCiphersResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + "DHE-RSA-AES128-SHA256" | Set-SFNodeSupplementalTlsCiphers + + Enables a specific supplemental Tls cipher + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + (Get-SFSupportedTlsCiphers).SupportedSupplementalCiphers | Set-SFSupplementalTlsCiphers + + Enables all supported supplemental Tls ciphers + + + + + + + Set-SFVirtualNetwork + + [Cluster] Modifies various attributes of a VirtualNetwork object. + + + + + Set + SFVirtualNetwork + + + + [Cluster] Modifies various attributes of a VirtualNetwork object. + + + + Set-SFVirtualNetwork + + VirtualNetworkID + + + + long + + + + Name + + New name for the network. + + string + + + + AddressBlocks + + New addressBlock to set for this Virtual Network object. This may contain new address blocks to add to the existing object or it may omit unused address blocks that need to be removed. Alternatively, existing address blocks may be extended or reduced in size. The size of the starting addressBlocks for a Virtual Network object. + + AddressBlock[] + + + + Netmask + + New netmask for this virtual network. + + string + + + + Svip + + The storage virtual IP address for this virtual network. The svip for Virtual Network cannot be changed. A new Virtual Network must be created in order to use a different svip address. + + string + + + + Attributes + + A new list of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Set-SFVirtualNetwork + + VirtualNetworkTag + + A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported). + + long + + + + Name + + New name for the network. + + string + + + + AddressBlocks + + New addressBlock to set for this Virtual Network object. This may contain new address blocks to add to the existing object or it may omit unused address blocks that need to be removed. Alternatively, existing address blocks may be extended or reduced in size. The size of the starting addressBlocks for a Virtual Network object. + + AddressBlock[] + + + + Netmask + + New netmask for this virtual network. + + string + + + + Svip + + The storage virtual IP address for this virtual network. The svip for Virtual Network cannot be changed. A new Virtual Network must be created in order to use a different svip address. + + string + + + + Attributes + + A new list of Name/Value pairs in JSON object format. + + hashtable + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + AddressBlocks + + New addressBlock to set for this Virtual Network object. This may contain new address blocks to add to the existing object or it may omit unused address blocks that need to be removed. Alternatively, existing address blocks may be extended or reduced in size. The size of the starting addressBlocks for a Virtual Network object. + + AddressBlock[] + + AddressBlock[] + + + + + Attributes + + A new list of Name/Value pairs in JSON object format. + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + Name + + New name for the network. + + string + + string + + + + + Netmask + + New netmask for this virtual network. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Svip + + The storage virtual IP address for this virtual network. The svip for Virtual Network cannot be changed. A new Virtual Network must be created in order to use a different svip address. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualNetworkID + + Unique identifier of the virtual network to modify. + + long + + long + + + + + VirtualNetworkTag + + A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported). + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String +SolidFire.Element.Api.AddressBlock[] + + + + + + + + + + The modified VirtualNetwork object. + + + VirtualNetwork + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFVirtualNetwork -VirtualNetworkID 5 -Name "NewName" + + Changes the name of an existing virtual network. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $origVN = Get-SFVirtualNetwork -VirtualNetworkID 5 $AddBlocks = $origVN.AddressBlocks $AddBlocks += @{"start"="10.10.10.201";"size"="5"} -Set-SFVirtualNetwork -VirtualNetworkID $origVN.VirtualNetworkID -AddressBlocks $AddBlocks - - Adds an address block to an existing virtual network. - - - - - - - Set-SFVolume - - [Cluster] Modifies settings of an existing volume. - - - - - Set - SFVolume - - - - [Cluster] Modifies settings of an existing volume. - - - - Access - - Access allowed for the volume - - string - - string - - - - - - AccountID - - Account ID to which the volume is reassigned - - long - - long - - - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - BurstIOPS - - The maximum 4KB IOPS allowed for a short time - - long - - long - - - - - - Confirm - - - - - switch - - - - - - GB - - Switch used to interpret total size as GB - - - switch - - - - - - GiB - - Switch used to interpret total size as GiB - - - switch - - - - - - MaxIOPS - - The desired maximum 4KB IOPS to guarantee - - long - - long - - - - - - MinIOPS - - The desired minimum 4KB IOPS to guarantee - - long - - long - - - - - - Name - - VolumeName(s) for the volume(s) to be modified. - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SetCreateTime - - Identify the time at which the volume was created - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - TotalSize - - New size of the volume in GB. You can only increase a volumes size - - long - - long - - - - - - VolumeID - - VolumeID(s) for the volume(s) to be modified - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] - - - - - [Cluster] Modifies settings of an existing volume. - - - - - - - - - - Volume - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFVolume -VolumeID 29 -AccountID 12 - - Move a volume from one account to another. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Set-SFVolume -VolumeID 13 -TotalSize 150 -GB - +Set-SFVirtualNetwork -VirtualNetworkID $origVN.VirtualNetworkID -AddressBlocks $AddBlocks + + Adds an address block to an existing virtual network. + + + + + + + Set-SFVolume + + [Cluster] Modifies settings of an existing volume. + + + + + Set + SFVolume + + + + [Cluster] Modifies settings of an existing volume. + + + + Set-SFVolume + + VolumeID + + VolumeID(s) for the volume(s) to be modified + + long[] + + + + AccountID + + Account ID to which the volume is reassigned + + long + + + + Access + + Access allowed for the volume + + string + + + + Attributes + + Attributes to set + + hashtable + + + + SetCreateTime + + Identify the time at which the volume was created + + string + + + + QoSPolicyID + + The ID for the policy whose QoS settings should be applied to the specified volumes. + + int + + + + AssociateWithQoSPolicy + + Associate the volume with the specified QoSPolicyID. + + bool + + + + TotalSize + + New size of the volume in GB. You can only increase a volumes size + + long + + + + GB + + Switch used to interpret total size as GB + + + + + GiB + + Switch used to interpret total size as GiB + + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + + + EnableSnapMirrorReplication + + Determines whether the volume can be used for replication with SnapMirror endpoints. + + bool + + + + FifoSize + + Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. + + long + + + + MinFifoSize + + Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + Set-SFVolume + + VolumeID + + VolumeID(s) for the volume(s) to be modified + + long[] + + + + AccountID + + Account ID to which the volume is reassigned + + long + + + + Access + + Access allowed for the volume + + string + + + + Attributes + + Attributes to set + + hashtable + + + + SetCreateTime + + Identify the time at which the volume was created + + string + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + + + TotalSize + + New size of the volume in GB. You can only increase a volumes size + + long + + + + GB + + Switch used to interpret total size as GB + + + + + GiB + + Switch used to interpret total size as GiB + + + + + QoSPolicyID + + The ID for the policy whose QoS settings should be applied to the specified volumes. + + int + + + + AssociateWithQoSPolicy + + Associate the volume with the specified QoSPolicyID. + + bool + + + + EnableSnapMirrorReplication + + Determines whether the volume can be used for replication with SnapMirror endpoints. + + bool + + + + FifoSize + + Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. + + long + + + + MinFifoSize + + Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Access + + Access allowed for the volume + + string + + string + + + + + AccountID + + Account ID to which the volume is reassigned + + long + + long + + + + + AssociateWithQoSPolicy + + Associate the volume with the specified QoSPolicyID. + + bool + + bool + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + BurstIOPS + + The maximum 4KB IOPS allowed for a short time + + int + + int + + + + + BurstTime + + The time to allow a burst of maximum 4KB IOPS + + int + + int + + + + + Confirm + + + + + switch + + + + + EnableSnapMirrorReplication + + Determines whether the volume can be used for replication with SnapMirror endpoints. + + bool + + bool + + + + + FifoSize + + Specifies the maximum number of FIFO (First-In-First-Out) snapshots supported by the volume. + + long + + long + + + + + GB + + Switch used to interpret total size as GB + + + switch + + + + + GiB + + Switch used to interpret total size as GiB + + + switch + + + + + MaxIOPS + + The desired maximum 4KB IOPS to guarantee + + int + + int + + + + + MinFifoSize + + Specifies the number of snapshot slots that are reserved for only FIFO (First-In-First-Out) snapshots. + + long + + long + + + + + MinIOPS + + The desired minimum 4KB IOPS to guarantee + + int + + int + + + + + QoSPolicyID + + The ID for the policy whose QoS settings should be applied to the specified volumes. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SetCreateTime + + Identify the time at which the volume was created + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TotalSize + + New size of the volume in GB. You can only increase a volumes size + + long + + long + + + + + VolumeID + + VolumeID(s) for the volume(s) to be modified + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +System.Nullable`1[[System.Int64, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] + + + + + + + + + + + + + Volume + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFVolume -VolumeID 29 -AccountID 12 + + Move a volume from one account to another. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Set-SFVolume -VolumeID 13 -TotalSize 150 -GB + Increase the size of a specified volume to 150 GB. -Note that you can only increase a volume's size this way. To decrease a volume's size you must create a clone of the volume and decrease the size during the clone process. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Get-SFVolume -Name "VMware*" | Set-SFVolume -MinIOPS 1000 -MaxIOPS 2000 -BurstIOPS 5000 - - Change the QoS settings for all volumes with names that begin with "VMware". - - - - - - - Set-SFVolumeAccessGroup - - [Cluster] Configures the name or attributes of a VAG. - - - - - Set - SFVolumeAccessGroup - - - - [Cluster] Configures the name or attributes of a VAG. - - - - Attributes - - Attributes to set - - hashtable - - hashtable - - - - - - Confirm - - - - - switch - - - - - - Initiators - - List of initiators to include in the volume access group. If unspecified, the access group's configured initiators will not be modified. - - string[] - - string[] - - - - - - Name - - The new name for this volume access group - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VirtualNetworkID - - The ID of the SolidFire Virtual Network ID to associate the volume access group with. - - long[] - - long[] - - - - - - VirtualNetworkTags - - The ID of the VLAN Virtual Network Tag to associate the volume access group with. - - long[] - - long[] - - - - - - VolumeAccessGroupID - - The ID of the volume access group to modify - - long - - long - - - - - - Volumes - - List of volumes to initially include in the volume access group. If unspecified, the access group's volumes will not be modified. - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 - - - - - [Cluster] Configures the name or attributes of a VAG. - - - - - - - - - - VolumeAccessGroup - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFVolumeAccessGroup -VolumeAccessGroupID 3 -Name NewVolumeAccessGroupName - - Changes the name of the specified volume access group. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Note that you can only increase a volume's size this way. To decrease a volume's size you must create a clone of the volume and decrease the size during the clone process. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Get-SFVolume -Name "VMware*" | Set-SFVolume -MinIOPS 1000 -MaxIOPS 2000 -BurstIOPS 5000 + + Change the QoS settings for all volumes with names that begin with "VMware". + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Set-SFVolume -VolumeID 99 -QoSPolicyID 777 -AssociateWithQoSPolicy:$true + + Modify the volume with ID 99 to use QoSPolicy with ID 777 and associate the volume with the QoS policy so that the volume will inherit any future changes to the policy. + + + + + + + Set-SFVolumeAccessGroup + + [Cluster] Configures the name or attributes of a VAG. + + + + + Set + SFVolumeAccessGroup + + + + [Cluster] Configures the name or attributes of a VAG. + + + + Set-SFVolumeAccessGroup + + VolumeAccessGroupID + + The ID of the volume access group to modify + + long + + + + Name + + The new name for this volume access group + + string + + + + Attributes + + Attributes to set + + hashtable + + + + VirtualNetworkID + + + + long[] + + + + VirtualNetworkTags + + + + long[] + + + + Initiators + + List of initiators to include in the volume access group. If unspecified, the access group's configured initiators will not be modified. + + string[] + + + + Volumes + + List of volumes to initially include in the volume access group. If unspecified, the access group's volumes will not be modified. + + long[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Attributes + + Attributes to set + + hashtable + + hashtable + + + + + Confirm + + + + + switch + + + + + Initiators + + List of initiators to include in the volume access group. If unspecified, the access group's configured initiators will not be modified. + + string[] + + string[] + + + + + Name + + The new name for this volume access group + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VirtualNetworkID + + + + long[] + + long[] + + + + + VirtualNetworkTags + + + + long[] + + long[] + + + + + VolumeAccessGroupID + + The ID of the volume access group to modify + + long + + long + + + + + Volumes + + List of volumes to initially include in the volume access group. If unspecified, the access group's volumes will not be modified. + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 + + + + + + + + + + + + + VolumeAccessGroup + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFVolumeAccessGroup -VolumeAccessGroupID 3 -Name NewVolumeAccessGroupName + + Changes the name of the specified volume access group. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $inits = Get-SFInitiator -Alias '' -Set-SFVolumeAccessGroup -VolumeAccessGroupID 1 -Initiators $inits - - Adds all initators with no alias to VolumeAccessGroup 1. - - - - - - - Set-SFVolumePair - - [Cluster] Pauses or restarts replication between a pair of volumes. - - - - - Set - SFVolumePair - - - - [Cluster] Pauses or restarts replication between a pair of volumes. - - - - Confirm - - - - - switch - - - - - - Mode - - Volume replication mode. - - string - - string - - - - - - PausedManual - - Pause replication. - - bool - - bool - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - List of IDs of active paired volumes to be modified. - - long[] - - long[] - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64[] -System.String - - - - - [Cluster] Pauses or restarts replication between a pair of volumes. - - - - - - - - - - ModifyVolumePairResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyVolumePairResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Set-SFVolumePair -VolumeID 8,9 -Mode Sync -PausedManual:$true -Confirm:$false - - Sets the Mode to 'Synx' and pauses data replication with no confirmation prompt. - - - - - - - Start-SFClusterPairing - - [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. - - - - - Start - SFClusterPairing - - - - [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. - - - - - - - - - - StartClusterPairingResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartClusterPairingResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - +Set-SFVolumeAccessGroup -VolumeAccessGroupID 1 -Initiators $inits.InitiatorName + + Adds all initators with no alias to VolumeAccessGroup 1. + + + + + + + Set-SFVolumePair + + [Cluster] Enables you to Pause or Restart replication between a pair of volumes. + + + + + Set + SFVolumePair + + + + [Cluster] Pauses or restarts replication between a pair of volumes. + + + + Set-SFVolumePair + + VolumeID + + List of IDs of active paired volumes to be modified. + + long[] + + + + PausedManual + + Pause replication. + + bool + + + + Mode + + Volume replication mode. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Mode + + Volume replication mode. + + string + + string + + + + + PausedManual + + Pause replication. + + bool + + bool + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + List of IDs of active paired volumes to be modified. + + long[] + + long[] + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64[] +System.String + + + + + + + + + + + + + ModifyVolumePairResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyVolumePairResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Set-SFVolumePair -VolumeID 8,9 -Mode Sync -PausedManual:$true -Confirm:$false + + Sets the Mode to 'Sync' and pauses data replication with no confirmation prompt. + + + + + + + Start-SFClusterPairing + + [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. + + + + + Start + SFClusterPairing + + + + [Cluster] Creates an encoded key from a cluster that is used to pair with another cluster. + + + + Start-SFClusterPairing + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + StartClusterPairingResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartClusterPairingResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + $key = Start-SFClusterPairing -Complete-SFClusterPairing -ClusterPairingKey $key.ClusterPairingKey - - Gets ClusterPairingKey object. - - - - - - - Start-SFVolumeBackup - - [Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume. - - - - - Start - SFVolumeBackup - - - - [Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume. - - - - BackupTo - - The target on which to store the backup of volume data. Can be: SolidFire, Swift, or S3. - - string - - string - - - - - - Format - - The format of the volume data. Can be: uncompressed or native. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - SnapshotID - - The ID of a previously created snapshot used for bulk volume reads. - - long - - long - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - The ID of the volume to be read. - - long - - long - - - - - - - - - System.Int64 -System.String - - - - - [Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume. - - - - - - - - - - StartBulkVolumeReadResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartBulkVolumeReadResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Start-SFVolumeBackup -VolumeID 5 -SnapshotID 4 -Format native -BackupTo SolidFire -Mvip 10.117.61.129 -Username admin -Password admin -BulkVolumeWriteKey abc - - Backs up specified volume in native format, along with using a snapshot, to SolidFire. Requires Mvip, login information, and BulkVolumeWriteKey. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Start-SFVolumeBackup -VolumeID 7 -Format uncompressed -BackupTo S3 -Hostname 10.117.61.125 -AccessKeyID abc -SecretAccessKey 123 -Bucket 5 - - Backs up specified volume uncompressed to S3. Requires Hostname, AccessKeyID, SecretAccessKey, and Bucket number. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Start-SFVolumeBackup -VolumeID 7 -Format uncompressed -BackupTo Swift -Url 10.117.63.128:8443 -Username admin -AuthenticationKey abc -Container 5 - - Backs up specified volume uncompressed to Swift. Requires URL, Username, AuthenticationKey, and Container. - - - - - - - Start-SFVolumePairing - - [Cluster] Creates an encoded key from a volume that is used to pair with another volume. - - - - - Start - SFVolumePairing - - - - [Cluster] Creates an encoded key from a volume that is used to pair with another volume. - - - - Mode - - The mode of the volume on which to start the pairing process. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - The ID of the volume on which to start the pairing process. - - long - - long - - - - - - - - - System.Int64 -System.String - - - - - [Cluster] Creates an encoded key from a volume that is used to pair with another volume. - - - - - - - - - - StartVolumePairingResult - http://solidfire.github.io/sdk-dotnet/help//html/T_SolidFire_Element_Api_StartVolumePairingResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - $vol = Start-SFVolumePairing -VolumeID 8 -Mode Async -Complete-SFVolumePairing -VolumeID 9 -VolumePairingKey $vol.VolumePairingKey - - Saved the pairing key from the Start command, while setting Mode to "Async", and uses it to complete pairing with another volume. - - - - - - - Start-SFVolumeRestore - - [Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume. - - - - - Start - SFVolumeRestore - - - - [Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume. - - - - Confirm - - - - - switch - - - - - - Format - - The format of the volume data. Can be: uncompressed or native. - - string - - string - - - - - - RestoreFrom - - The source of object data that was created from a previous backup. Can be: SolidFire, Swift, or S3. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - VolumeID - - The ID of the volume to be read. - - long - - long - - - - - - WhatIf - - - - - switch - - - - - - - - - System.Int64 -System.String - - - - - [Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume. - - - - - - - - - - StartBulkVolumeWriteResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartBulkVolumeWriteResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Start-SFVolumeRestore -VolumeID 7 -Format native -RestoreFrom SolidFire -Confirm:$false - - Starts a volume restore on specified volume with native format. Uses "SolidFire" as RestoreFrom location and has no confirmation prompt. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Start-SFVolumeRestore -VolumeID 9 -Format uncompressed -RestoreFrom Swift -Confirm:$false - - Starts a volume restore on specified volume with "uncompressed" format. Uses "Swift" as RestoreFrom location and has no confirmation prompt. - - - - - - - Stop-SFClone - - Cancels a currently running clone operation. This method does not return anything. - - - - - Stop - SFClone - - - - Cancels a currently running clone operation. This method does not return anything. - - - - CloneID - - The id of the clone you wish to stop. This should have been returned when you first made the object - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64 - - - - - Cancels a currently running clone operation. This method does not return anything. - - - - - - - Cancels a currently running clone operation. This method does not return anything. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Stop-SFClone -CloneID 5 - - Stops specified clone by given CloneID. - - - - - - - Stop-SFGroupClone - - Stops an ongoing CloneMultipleVolumes process for a group of clones. - - - - - Stop - SFGroupClone - - - - Stops an ongoing CloneMultipleVolumes process for a group of clones. - - - - GroupCloneID - - group clone ID for the ongoing clone process. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - System.Int64 - - - - - Stops an ongoing CloneMultipleVolumes process for a group of clones. - - - - - - - CancelGroupClone enables you to stop an ongoing CloneMultipleVolumes process for a group of clones. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle. This method does not return anything. - - - System.Object - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Stop-SFGroupClone -GroupCloneID 5 - - Stops specified GroupClone by given GroupCloneID. - - - - - - - Test-SFConnectEnsemble - - [Node] Verifies connectivity with a specified database ensemble. - - - - - Test - SFConnectEnsemble - - - - [Node] Verifies connectivity with a specified database ensemble. - - - - Ensemble - - An array of ensemble node CIPs for connectivity testing - - string[] - - string[] - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Verifies connectivity with a specified database ensemble. - - - - - - - - - - TestConnectEnsembleResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectEnsembleResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFConnectEnsemble - - Tests connectivity with current cluster's ensemble. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Test-SFConnectEnsemble -Ensemble 10.117.61.125 - - Tests connectivity with specified ensemble. - - - - - - - Test-SFConnectMvip - - [Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity. - - - - - Test - SFConnectMvip - - - - [Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity. - - - - Mvip - - Use this to test the management connection of a different MVIP. This is not needed to test the connection to the target cluster. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity. - - - - - - - - - - TestConnectMvipResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectMvipResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFConnectMvip - - Verifies the MVIP connectivity of current cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Test-SFConnectMvip -Mvip 10.117.61.125 - - Verifies the connectectivity of specified MVIP. - - - - - - - Test-SFConnectSvip - - [Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity. - - - - - Test - SFConnectSvip - - - - [Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Svip - - Use this to test the storage connection of a different SVIP. This is not needed to test the connection to the target cluster. - - string - - string - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity. - - - - - - - - - - TestConnectSvipResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectSvipResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFConnectSvip - - Verifies the SVIP connectivity of current cluster. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Test-SFConnectSvip -Mvip 10.117.61.125 - - Verifies the connectectivity of specified SVIP. - - - - - - - Test-SFDrives - - [Node] Run a hardware validation on all drives on the node. - - - - - Test - SFDrives - - - - You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster. - - - - Confirm - - You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster. - - - switch - - - - - - Minutes - - Specifies the number of minutes to run the test. - - int - - int - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - WhatIf - - You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster. - - - switch - - - - - - - - - None - - - - - You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster. - - - - - - - - - - TestDrivesResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestDrivesResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFDrives -Minutes 20 - - Test the drives on the node for up to 20 minutes. - - - - - - - Test-SFLdapAuthentication - - [Cluster] Verifies LDAP authentication configuration. - - - - - Test - SFLdapAuthentication - - - - [Cluster] Verifies LDAP authentication configuration. - - - - LdapConfiguration - - An LdapConfiguration object to be tested. Optional. - - LdapConfiguration - - LdapConfiguration - - - - - - Password - - The password for the username to be tested. - - string - - string - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - Username - - The distinguished user name for the new LDAP cluster admin. - - string - - string - - - - - - - - - System.String - - - - - [Cluster] Verifies LDAP authentication configuration. - - - - - - - - - - TestLdapConfigurationResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestLdapAuthenticationResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFLdapAuthentication -Username admin -Password admin - - Tests the LDAP Authentication with login credentials. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - +Complete-SFClusterPairing -ClusterPairingKey $key.ClusterPairingKey + + Gets ClusterPairingKey object. + + + + + + + Start-SFResyncSnapMirrorRelationship + + [Cluster] Start-SFResyncSnapMirrorRelationship establishs or reestablishs a mirror relationship between a source and destination endpoint. When you resync a relationship, the system removes snapshots on the destination volume that are newer than the common snapshot copy, and then mounts the destination volume as a data protection volume with the common snapshot copy as the exported snapshot copy. + + + + + Start + SFResyncSnapMirrorRelationship + + + + [Cluster] Start-SFResyncSnapMirrorRelationship establishs or reestablishs a mirror relationship between a source and destination endpoint. When you resync a relationship, the system removes snapshots on the destination volume that are newer than the common snapshot copy, and then mounts the destination volume as a data protection volume with the common snapshot copy as the exported snapshot copy. + + + + Start-SFResyncSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + SourceVolumeType + + The source volume's type in the SnapMirror relationship. (Source volume is completely optional) + + string + + + + SourceVolumeName + + The source volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + SourceVolumeVserver + + The source volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + SourceVolumeID + + The source volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + SourceVolumeID + + The source volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + SourceVolumeName + + The source volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + SourceVolumeType + + The source volume's type in the SnapMirror relationship. (Source volume is completely optional) + + string + + string + + + + + SourceVolumeVserver + + The source volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + ResyncSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResyncSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Start-SFResyncSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Starts a resync with the destination volume. Source Volume is optional. + + + + + + + Start-SFVolumeBackup + + [Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume. + + + + + Start + SFVolumeBackup + + + + [Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume. + + + + Start-SFVolumeBackup + + VolumeID + + The ID of the volume to be read. + + long + + + + Format + + The format of the volume data. Can be: uncompressed or native. + + string + + + + BackupTo + + The target on which to store the backup of volume data. Can be: SolidFire, Swift, or S3. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + BackupTo + + The target on which to store the backup of volume data. Can be: SolidFire, Swift, or S3. + + string + + string + + + + + Format + + The format of the volume data. Can be: uncompressed or native. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapshotID + + The ID of a previously created snapshot used for bulk volume reads. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + The ID of the volume to be read. + + long + + long + + + + + + + + System.Int64 +System.String + + + + + + + + + + + + + StartBulkVolumeReadResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartBulkVolumeReadResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Start-SFVolumeBackup -VolumeID 5 -SnapshotID 4 -Format native -BackupTo SolidFire -Mvip 10.117.61.129 -Username admin -Password admin -BulkVolumeWriteKey abc + + Backs up specified volume in native format, along with using a snapshot, to SolidFire. Requires Mvip, login information, and BulkVolumeWriteKey. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Start-SFVolumeBackup -VolumeID 7 -Format uncompressed -BackupTo S3 -Hostname 10.117.61.125 -AccessKeyID abc -SecretAccessKey 123 -Bucket 5 + + Backs up specified volume uncompressed to S3. Requires Hostname, AccessKeyID, SecretAccessKey, and Bucket number. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Start-SFVolumeBackup -VolumeID 7 -Format uncompressed -BackupTo Swift -Url 10.117.63.128:8443 -Username admin -AuthenticationKey abc -Container 5 + + Backs up specified volume uncompressed to Swift. Requires URL, Username, AuthenticationKey, and Container. + + + + + + + Start-SFVolumePairing + + [Cluster] Creates an encoded key from a volume that is used to pair with another volume. The key that this cmdlet creates is then used in the Complete-SFVolumePairing cmdlet to establish a volume pair. + + + + + Start + SFVolumePairing + + + + [Cluster] Creates an encoded key from a volume that is used to pair with another volume. The key that this cmdlet creates is then used in the Complete-SFVolumePairing cmdlet to establish a volume pairing. + + + + Start-SFVolumePairing + + VolumeID + + The ID of the volume on which to start the pairing process. + + long + + + + Mode + + The mode of the volume on which to start the pairing process. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Mode + + The mode of the volume on which to start the pairing process. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + The ID of the volume on which to start the pairing process. + + long + + long + + + + + + + + System.Int64 +System.String + + + + + + + + + + + + + StartVolumePairingResult + http://solidfire.github.io/sdk-dotnet/help//html/T_SolidFire_Element_Api_StartVolumePairingResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + $vol_pairing_key = Start-SFVolumePairing -VolumeID 42 -Mode Async + + Creates a volume pairing key that is then used with the Complete-SFVolumePairing cmdlet to create a volume pair. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Start-SFVolumePairing -VolumeID 42 -Mode Async -Target Cluster1 | Complete-SFVolumePairing -VolumeID 18 -Target Cluster2 + + Creates a volume pairing key and pipes it to the Complete-SFVolumePairing cmdlet to create a volume pair. + + + + + + + Start-SFVolumeRestore + + [Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume. + + + + + Start + SFVolumeRestore + + + + [Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume. + + + + Start-SFVolumeRestore + + VolumeID + + The ID of the volume to be read. + + long + + + + Format + + The format of the volume data. Can be: uncompressed or native. + + string + + + + RestoreFrom + + The source of object data that was created from a previous backup. Can be: SolidFire, Swift, or S3. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Format + + The format of the volume data. Can be: uncompressed or native. + + string + + string + + + + + RestoreFrom + + The source of object data that was created from a previous backup. Can be: SolidFire, Swift, or S3. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + VolumeID + + The ID of the volume to be read. + + long + + long + + + + + WhatIf + + + + + switch + + + + + + + + System.Int64 +System.String + + + + + + + + + + + + + StartBulkVolumeWriteResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartBulkVolumeWriteResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Start-SFVolumeRestore -VolumeID 7 -Format native -RestoreFrom SolidFire -Confirm:$false + + Starts a volume restore on specified volume with native format. Uses "SolidFire" as RestoreFrom location and has no confirmation prompt. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Start-SFVolumeRestore -VolumeID 9 -Format uncompressed -RestoreFrom Swift -Confirm:$false + + Starts a volume restore on specified volume with "uncompressed" format. Uses "Swift" as RestoreFrom location and has no confirmation prompt. + + + + + + + Stop-SFClone + + Cancels a currently running clone operation. This method does not return anything. + + + + + Stop + SFClone + + + + Cancels a currently running clone operation. This method does not return anything. + + + + Stop-SFClone + + CloneID + + The id of the clone you wish to stop. This should have been returned when you first made the object + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + CloneID + + The id of the clone you wish to stop. This should have been returned when you first made the object + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64 + + + + + + + + + + Cancels a currently running clone operation. This method does not return anything. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Stop-SFClone -CloneID 5 + + Stops specified clone by given CloneID. + + + + + + + Stop-SFGroupClone + + Stops an ongoing CloneMultipleVolumes process for a group of clones. + + + + + Stop + SFGroupClone + + + + Stops an ongoing CloneMultipleVolumes process for a group of clones. + + + + Stop-SFGroupClone + + GroupCloneID + + group clone ID for the ongoing clone process. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + GroupCloneID + + group clone ID for the ongoing clone process. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Int64 + + + + + + + + + + CancelGroupClone enables you to stop an ongoing CloneMultipleVolumes process for a group of clones. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle. This method does not return anything. + + + System.Object + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Stop-SFGroupClone -GroupCloneID 5 + + Stops specified GroupClone by given GroupCloneID. + + + + + + + Stop-SFSnapMirrorRelationship + + [Cluster] Stop-SFSnapMirrorRelationship stops SnapMirror transfers that have started but are not yet complete. + + + + + Stop + SFSnapMirrorRelationship + + + + [Cluster] Stop-SFSnapMirrorRelationship stops SnapMirror transfers that have started but are not yet complete. + + + + Stop-SFSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + ClearCheckpoint + + Determines whether or not to clear the restart checkpoint. + + bool + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + ClearCheckpoint + + Determines whether or not to clear the restart checkpoint. + + bool + + bool + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + AbortSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AbortSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Stop-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Stops the SnapMirror transfer that is currently running on the targeted relationship. + + + + + + + Test-SFConnectEnsemble + + [Node] Verifies connectivity with a specified database ensemble. + + + + + Test + SFConnectEnsemble + + + + [Node] Verifies connectivity with a specified database ensemble. + + + + Test-SFConnectEnsemble + + Ensemble + + An array of ensemble node CIPs for connectivity testing + + string[] + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Ensemble + + An array of ensemble node CIPs for connectivity testing + + string[] + + string[] + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + TestConnectEnsembleResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectEnsembleResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFConnectEnsemble + + Tests connectivity with current cluster's ensemble. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Test-SFConnectEnsemble -Ensemble 10.117.61.125 + + Tests connectivity with specified ensemble. + + + + + + + Test-SFConnectMvip + + [Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity. + + + + + Test + SFConnectMvip + + + + [Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity. + + + + Test-SFConnectMvip + + Mvip + + Use this to test the management connection of a different MVIP. This is not needed to test the connection to the target cluster. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Mvip + + Use this to test the management connection of a different MVIP. This is not needed to test the connection to the target cluster. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + TestConnectMvipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectMvipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFConnectMvip + + Verifies the MVIP connectivity of current cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Test-SFConnectMvip -Mvip 10.117.61.125 + + Verifies the connectectivity of specified MVIP. + + + + + + + Test-SFConnectSvip + + [Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity. + + + + + Test + SFConnectSvip + + + + [Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity. + + + + Test-SFConnectSvip + + Svip + + Use this to test the storage connection of a different SVIP. This is not needed to test the connection to the target cluster. + + string + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Svip + + Use this to test the storage connection of a different SVIP. This is not needed to test the connection to the target cluster. + + string + + string + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + TestConnectSvipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectSvipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFConnectSvip + + Verifies the SVIP connectivity of current cluster. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Test-SFConnectSvip -Mvip 10.117.61.125 + + Verifies the connectectivity of specified SVIP. + + + + + + + Test-SFDrives + + [Node] Run a hardware validation on all drives on the node. + + + + + Test + SFDrives + + + + You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster. + + + + Test-SFDrives + + Minutes + + Specifies the number of minutes to run the test. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + WhatIf + + + + + + + Confirm + + + + + + + + + + Confirm + + + + + switch + + + + + Minutes + + Specifies the number of minutes to run the test. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + WhatIf + + + + + switch + + + + + + + + None + + + + + + + + + + + + + TestDrivesResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestDrivesResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFDrives -Minutes 20 + + Test the drives on the node for up to 20 minutes. + + + + + + + Test-SFKeyProviderKmip + + Test whether the specified KMIP (Key Management Interoperability Protocol) Key Provider is functioning normally. + + + + + Test + SFKeyProviderKmip + + + + Test whether the specified KMIP (Key Management Interoperability Protocol) Key Provider is functioning normally. + + + + Test-SFKeyProviderKmip + + KeyProviderID + + The ID of the Key Server to test. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyProviderID + + The ID of the Key Server to test. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + TestKeyProviderKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-KeyProviderKmip -KeyProviderID:1 + + Tests that the KMIP Key Provider with KeyProviderID=1 is functioning + + + + + + + Test-SFKeyServerKmip + + Test whether the specified KMIP (Key Management Interoperability Protocol) Key Server is functioning normally. + + + + + Test + SFKeyServerKmip + + + + Test whether the specified KMIP (Key Management Interoperability Protocol) Key Server is functioning normally. + + + + Test-SFKeyServerKmip + + KeyServerID + + The ID of the Key Server to test. + + int + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + KeyServerID + + The ID of the Key Server to test. + + int + + int + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + TestKeyServerKmipResult + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-KeyServerKmip -KeyServerID:1 + + Tests that the KMIP Key Server with KeyServerID=1 is functioning + + + + + + + Test-SFLdapAuthentication + + [Cluster] Verifies LDAP authentication configuration. + + + + + Test + SFLdapAuthentication + + + + [Cluster] Verifies LDAP authentication configuration. + + + + Test-SFLdapAuthentication + + Username + + The distinguished user name for the new LDAP cluster admin. + + string + + + + Password + + The password for the username to be tested. + + string + + + + LdapConfiguration + + An LdapConfiguration object to be tested. Optional. + + LdapConfiguration + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + LdapConfiguration + + An LdapConfiguration object to be tested. Optional. + + LdapConfiguration + + LdapConfiguration + + + + + Password + + The password for the username to be tested. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + Username + + The distinguished user name for the new LDAP cluster admin. + + string + + string + + + + + + + + System.String + + + + + + + + + + + + + TestLdapConfigurationResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestLdapAuthenticationResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFLdapAuthentication -Username admin -Password admin + + Tests the LDAP Authentication with login credentials. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + $data = Get-SFLdapConfiguration -Test-SFLdapAuthentication -Username admin -Password admin -LdapConfiguration $data - - Gets the SFLdapConfiguration and uses it to test the LdapConfiguration with given login credentials. - - - - - - - Test-SFPing - - [Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. - - - - - Test - SFPing - - - - [Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. - - - - Attempts - - Specifies the number of times the system should repeat the test ping. Default is 5. - - long - - long - - - - - - Hosts - - Specify address or hostnames of devices to ping. - - string[] - - string[] - - - - - - PacketSize - - Specify the number of bytes to send in the ICMP packet sent to each IP. Number be less than the maximum MTU specified in the network configuration. - - long - - long - - - - - - PingTimeoutMsec - - Specify the number of milliseconds to wait for each individual ping response. Default is 500ms. - - long - - long - - - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - TotalTimeoutSec - - Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process. - - long - - long - - - - - - - - - None - - - - - [Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. - - - - - - - - - - TestPingResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestPingResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFPing - - Default output. - - - - -------------------------- EXAMPLE 2 -------------------------- - - PS C:\> - - Test-SFPing -Attempts 1 -Hosts 10.117.61.129, 10.117.61.125 - - Validates specified nodes with only 1 allowed attempt. - - - - -------------------------- EXAMPLE 3 -------------------------- - - PS C:\> - - Test-SFPing -PacketSize 100 -TotalTimeoutSec 5 -PingTimeoutMsec 100 - - Validates all nodes with specified PacketSize, total timeout, and ping timeout. - - - - - - - Test-SFSendSnmpTrap - - [Cluster] Sends SNMP test signal to active trap targets. - - - - - Test - SFSendSnmpTrap - - - - [Cluster] Sends SNMP test signal to active trap targets. - - - - SFConnection - - - - SFConnection[] - - SFConnection[] - - - - - - Target - - - - string[] - - string[] - - - - - - - - - None - - - - - [Cluster] Sends SNMP test signal to active trap targets. - - - - - - - - - - SnmpSendTestTrapsResult - http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SnmpSendTestTrapsResult.htm - - - - - - -------------------------- EXAMPLE 1 -------------------------- - - PS C:\> - - Test-SFSendSnmpTrap - - - - - - +Test-SFLdapAuthentication -Username admin -Password admin -LdapConfiguration $data + + Gets the SFLdapConfiguration and uses it to test the LdapConfiguration with given login credentials. + + + + + + + Test-SFPing + + [Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. + + + + + Test + SFPing + + + + [Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets. + + + + Test-SFPing + + Attempts + + Specifies the number of times the system should repeat the test ping. Default is 5. + + long + + + + Hosts + + Specify address or hostnames of devices to ping. + + string[] + + + + TotalTimeoutSec + + Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process. + + long + + + + PacketSize + + Specify the number of bytes to send in the ICMP packet sent to each IP. Number be less than the maximum MTU specified in the network configuration. + + long + + + + PingTimeoutMsec + + Specify the number of milliseconds to wait for each individual ping response. Default is 500ms. + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + Attempts + + Specifies the number of times the system should repeat the test ping. Default is 5. + + long + + long + + + + + Hosts + + Specify address or hostnames of devices to ping. + + string[] + + string[] + + + + + PacketSize + + Specify the number of bytes to send in the ICMP packet sent to each IP. Number be less than the maximum MTU specified in the network configuration. + + long + + long + + + + + PingTimeoutMsec + + Specify the number of milliseconds to wait for each individual ping response. Default is 500ms. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + TotalTimeoutSec + + Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process. + + long + + long + + + + + + + + None + + + + + + + + + + + + + TestPingResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestPingResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFPing + + Default output. + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Test-SFPing -Attempts 1 -Hosts 10.117.61.129, 10.117.61.125 + + Validates specified nodes with only 1 allowed attempt. + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Test-SFPing -PacketSize 100 -TotalTimeoutSec 5 -PingTimeoutMsec 100 + + Validates all nodes with specified PacketSize, total timeout, and ping timeout. + + + + + + + Test-SFSendSnmpTrap + + [Cluster] Sends SNMP test signal to active trap targets. + + + + + Test + SFSendSnmpTrap + + + + [Cluster] Sends SNMP test signal to active trap targets. + + + + Test-SFSendSnmpTrap + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + SnmpSendTestTrapsResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SnmpSendTestTrapsResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Test-SFSendSnmpTrap + + + + + + + + + Update-SFIdpConfiguration + + [Cluster] Update an existing configuration with a third party Identity Provider (IdP) for the cluster. + + + + + Update + SFIdpConfiguration + + + + Update an existing configuration with a third party Identity Provider (IdP) for the cluster. + + + + Update-SFIdpConfiguration + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + + + NewIdpName + + If specified replaces the IdP name. + + string + + + + IdpMetadata + + IdP Metadata for configuration and integration details for SAML 2.0 single sign-on. IdP metadata, in plain text format, is retrieved from the third-party IdP. This metadata needs to be validated to ensure that it is correctly formatted in JSON. + + string + + + + GenerateNewCertificate + + Generate new SAML key/certificate and replace the existing pair. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + Update-SFIdpConfiguration + + IdpName + + Name for identifying and retrieving IdP provider for SAML 2.0 single sign-on. + + string + + + + NewIdpName + + If specified replaces the IdP name. + + string + + + + IdpMetadata + + IdP Metadata for configuration and integration details for SAML 2.0 single sign-on. IdP metadata, in plain text format, is retrieved from the third-party IdP. This metadata needs to be validated to ensure that it is correctly formatted in JSON. + + string + + + + GenerateNewCertificate + + Generate new SAML key/certificate and replace the existing pair. + + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + GenerateNewCertificate + + Generate new SAML key/certificate and replace the existing pair. + + + switch + + + + + IdpConfigurationID + + UUID for the third party Identity Provider (IdP) Configuration. + + guid + + guid + + + + + IdpMetadata + + IdP Metadata for configuration and integration details for SAML 2.0 single sign-on. IdP metadata, in plain text format, is retrieved from the third-party IdP. This metadata needs to be validated to ensure that it is correctly formatted in JSON. + + string + + string + + + + + IdpName + + Name for identifying and retrieving IdP provider for SAML 2.0 single sign-on. + + string + + string + + + + + NewIdpName + + If specified replaces the IdP name. + + string + + string + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + System.Guid +System.String +System.Management.Automation.SwitchParameter + + + + + + + + + + + + + IdpConfigInfo + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Update-SFIdpConfiguration -IdpName testidp -NewIdpName adfsip + + Update the existing IDP configuration with NewIdpName adfsidp when IdpName is given + + + + -------------------------- EXAMPLE 2 -------------------------- + + PS C:\> + + Update-SFIdpConfiguration -IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a -NewIdpName adfsip + + Update the existing IDP configuration with NewIdpName adfsidp when IdpConfigurationID is given + + + + -------------------------- EXAMPLE 3 -------------------------- + + PS C:\> + + Update-SFIdpConfiguration -IdpName adfsidp -IdpMetadata <adfsmetadata> + + Update the existing IDP Configuration with IdpMetadata when IdpName is given + + + + -------------------------- EXAMPLE 4 -------------------------- + + PS C:\> + + Update-SFIdpConfiguration -IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a -IdpMetadata <adfsmetadata> + + Update the existing IDP Configuration with IdpMetadata when IdpConfigurationID is given + + + + -------------------------- EXAMPLE 5 -------------------------- + + PS C:\> + + Update-SFIdpConfiguration -IdpName adfsidp -GenerateNewCertificate + + Update the existing IDP Configuration with NewCertificate when IdpName is given + + + + -------------------------- EXAMPLE 6 -------------------------- + + PS C:\> + + Update-SFIdpConfiguration -IdpConfigurationID 3cadaa53-132f-4e01-b0e0-a6d32888734a -GenerateNewCertificate + + Update the existing IDP Configuration with NewCertificate when IdpConfigurationID is given + + + + + + + Update-SFSnapMirrorRelationship + + [Cluster] Update-SFSnapMirrorRelationship makes the destination volume in a SnapMirror relationship an up-to-date mirror of the source volume. + + + + + Update + SFSnapMirrorRelationship + + + + [Cluster] Update-SFSnapMirrorRelationship makes the destination volume in a SnapMirror relationship an up-to-date mirror of the source volume. + + + + Update-SFSnapMirrorRelationship + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + + + Target + + Direct connection to specific Target + + string[] + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + + + + + + DestinationVolumeID + + The destination volume's ID in the SnapMirror relationship (only for type: solidfire). + + long + + long + + + + + DestinationVolumeName + + The destination volume's name in the SnapMirror relationship (required for ontap, optional for solidfire). + + string + + string + + + + + DestinationVolumeType + + The destination volume's type in the SnapMirror relationship. + + string + + string + + + + + DestinationVolumeVserver + + The destination volume's vserver in the SnapMirror relationship (only for type: ontap). + + string + + string + + + + + MaxTransferRate + + Specifies the maximum data transfer rate between the volumes in kilobytes per second. The default value, 0, is unlimited and permits the SnapMirror relationship to fully utilize the available network bandwidth. + + long + + long + + + + + SFConnection + + Direct connection to specific SFConnection + + SFConnection[] + + SFConnection[] + + + + + SnapMirrorEndpointID + + The endpoint ID of the remote ONTAP storage system communicating with the SolidFire cluster. + + long + + long + + + + + Target + + Direct connection to specific Target + + string[] + + string[] + + + + + + + + None + + + + + + + + + + + + + UpdateSnapMirrorRelationshipResult + http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_UpdateSnapMirrorRelationshipResult.htm + + + + + + -------------------------- EXAMPLE 1 -------------------------- + + PS C:\> + + Update-SFSnapMirrorRelationship -SnapMirrorEndpointID $endpoint.SnapMirrorEndpointID -DestinationVolumeType "ontap" -DestinationVolumeName $snapMirrorVolume.Name -DestinationVolumeVserver $vserverName + + Starts an update between the volumes in the relationship. Initialize-SFSnapMirrorRelationship must be called first, and takes 5+ minutes to run. Use Get-SFSnapMirrorRelationship to check the status. If the initialize fails, this cmdlet cannot be called. + + + + \ No newline at end of file diff --git a/packages/SolidFire.psd1 b/packages/SolidFire.psd1 deleted file mode 100644 index e3b89fb..0000000 Binary files a/packages/SolidFire.psd1 and /dev/null differ