StorSimple HCS Cmdlets in Windows PowerShell

Published: 25 July 2016 | Written by some jerk | Print | Email | Hits: 783

Windows Server 2012 R2 and Windows 8.1

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Windows Powershell Interface for StorSimple Hybrid Cloud Storage

This reference provides cmdlet descriptions and syntax for all of the StorSimple Hybrid Cloud Storage cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

Cmdlet	Description
Disable-HcsNetInterface	Disables a network interface.
Disable-HcsRemoteManagement	Disables Windows PowerShell remote management.
Disable-HcsSupportAccess	Disables support access to this device.
Disable-HcsWebProxy	Disables the web proxy for the device.
Enable-HcsNetInterface	Enables a network interface.
Enable-HcsRemoteManagement	Enables remote Windows PowerShell management.
Enable-HcsSupportAccess	Enables access to this device for Customer Service and Support.
Enable-HcsWebProxy	Enables the web proxy.
Enter-HcsMaintenanceMode	Puts a device into maintenance mode.
Enter-HcsSupportSession	Used by Microsoft Support to enter into an unrestricted PowerShell runspace for troubleshooting purposes.
Exit-HcsMaintenanceMode	Takes a device out of maintenance mode.
Export-HcsSupportPackage	Bundles logs into a single .zip file.
Get-HcsDnsClientServerAddress	Gets the server addresses that a Domain Name System (DNS) client device is configured to use.
Get-HcsFirmwareVersion	Gets the firmware versions of devices and displays the results.
Get-HcsNetInterface	Gets configuration information for a network interface.
Get-HcsNtpClientServerAddress	Gets URLs of the NTP servers for this device.
Get-HcsRemoteManagementCert	Gets the certificate for remote management.
Get-HcsSupportAccess	Gets the encrypted password that Customer Service and Support uses to access the device.
Get-HcsSystem	Gets system information about this StorSimple device.
Get-HcsUpdateAvailability	Scans for updates.
Get-HcsUpdateStatus	Gets the current status of updates.
Get-HcsWebProxy	Gets the web proxy configuration.
Get-HcsWuaVersion	Gets the version of the Windows Update Agent.
Invoke-HcsSetupWizard	Performs initial configuration and device registration.
Reset-HcsFactoryDefault	Resets one or both controllers to a factory default state.
Restart-HcsController	Restarts a controller.
Set-HcsDnsClientServerAddress	Sets the server addresses for a Domain Name System (DNS) client device.
Set-HcsNetInterface	Sets the configuration for a single network interface by alias.
Set-HcsNtpClientServerAddress	Sets the NTP URLs for this device.
Set-HcsPassword	Sets the password for a user account.
Set-HcsRemoteManagementCert	Generates the certificate for remote management.
Set-HcsSystem	Modifies settings for your StorSimple instance.
Set-HcsWebProxy	Sets the web proxy configuration.
Start-HcsFirmwareCheck	Checks whether a device needs a firmware update.
Start-HcsHotfix	Installs a hotfix on a StorSimple device.
Start-HcsUpdate	Installs updates.
Stop-HcsController	Stops a controller.
Test-HcsNtp	Attempts to synchronize the time to the NTP server.
Test-HcsStorageAccountCredential	Validates settings and connection for a cloud storage provider.

Note
To list all the cmdlets that are available, use the `Get-Command –Module HCS` cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

? Get-Help <cmdlet name> -Detailed
? Get-Help <cmdlet name> -Examples
? Get-Help <cmdlet name> -Full