Welcome to my StoreOnce PowerShell Module¶
This module PS-StoreOnce allows you to work with your HPE StoreOnce API through PowerShell functions. Project Page: http://mycloudrevolution.com/projekte/storeonce-powershell-module/
The main documentation for the site is organized into a couple sections:
Connect Commands¶
This page contains details on Connect commands.
Connect-SOAppliance¶
- NAME
- Connect-SOAppliance
- SYNOPSIS
- Connect to a StoreOnce Appliance
- SYNTAX
Connect-SOAppliance -Server <String> -Username <String> -Password <String> [-IgnoreCertRequirements] [<CommonParameters>]
Connect-SOAppliance -Server <String> -Credential <PSCredential> [-IgnoreCertRequirements] [<CommonParameters>]
- DESCRIPTION
- Connect to a StoreOnce Appliance and generate a connection object with Servername, Token etc.
- PARAMETERS
- -Server <String>
- StoreOnce Appliance to connect to
- -Username <String>
- Username to connect with
- -Password <String>
- Password to connect with
- -Credential <PSCredential>
- Credential object to connect with
-IgnoreCertRequirements [<SwitchParameter>]
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Connect-SOAppliance -Server d2d01.lan.local -Username TenantAdmin01 -Password P@ssword
————————– EXAMPLE 2 ————————–
PS C:>Connect-SOAppliance -Server d2d01.lan.local -Credential (Get-Credential)
#Requires PS -Version 4.0
- REMARKS
- To see the examples, type: “get-help Connect-SOAppliance -examples”. For more information, type: “get-help Connect-SOAppliance -detailed”. For technical information, type: “get-help Connect-SOAppliance -full”.
Get Commands¶
This page contains details on Get commands.
Get-SOAppliance¶
- NAME
- Get-SOAppliance
- SYNOPSIS
- Lists all connected StoreOnce Appliannce(s).
- SYNTAX
- Get-SOAppliance [<CommonParameters>]
- DESCRIPTION
- Lists all connected StoreOnce Appliannce(s).
- PARAMETERS
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Get-SOAppliance
#Requires PS -Version 4.0
- REMARKS
- To see the examples, type: “get-help Get-SOAppliance -examples”. For more information, type: “get-help Get-SOAppliance -detailed”. For technical information, type: “get-help Get-SOAppliance -full”.
Get-SOCatClients¶
CommonParameters : True WorkflowCommonParameters : False details : @{name=Get-SOCatClients; noun=; verb=} Syntax : @{syntaxItem=System.Object[]} parameters : @{parameter=System.Object[]} inputTypes : @{inputType=} returnValues : @{returnValue=} aliases : None
remarks : None alertSet : description : examples : Synopsis :
Get-SOCatClients [<CommonParameters>]
ModuleName : PS-StoreOnce nonTerminatingErrors : xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10 xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10 xmlns:maml : http://schemas.microsoft.com/maml/2004/10 Name : Get-SOCatClients Category : Function Component : Role : Functionality :
Get-SOCatStoreAccess¶
CommonParameters : True WorkflowCommonParameters : False details : @{name=Get-SOCatStoreAccess; noun=; verb=} Syntax : @{syntaxItem=System.Object[]} parameters : @{parameter=System.Object[]} inputTypes : @{inputType=} returnValues : @{returnValue=} aliases : None
remarks : None alertSet : description : examples : Synopsis :
Get-SOCatStoreAccess [-Server] <Object> [-CatStore] <string> [<CommonParameters>]
ModuleName : PS-StoreOnce nonTerminatingErrors : xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10 xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10 xmlns:maml : http://schemas.microsoft.com/maml/2004/10 Name : Get-SOCatStoreAccess Category : Function Component : Role : Functionality :
Get-SOCatStores¶
CommonParameters : True WorkflowCommonParameters : False details : @{name=Get-SOCatStores; noun=; verb=} Syntax : @{syntaxItem=System.Object[]} parameters : @{parameter=System.Object[]} inputTypes : @{inputType=} returnValues : @{returnValue=} aliases : None
remarks : None alertSet : description : examples : Synopsis :
Get-SOCatStores [<CommonParameters>]
ModuleName : PS-StoreOnce nonTerminatingErrors : xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10 xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10 xmlns:maml : http://schemas.microsoft.com/maml/2004/10 Name : Get-SOCatStores Category : Function Component : Role : Functionality :
Get-SOSIDs¶
CommonParameters : True WorkflowCommonParameters : False details : @{name=Get-SOSIDs; noun=; verb=} Syntax : @{syntaxItem=System.Object[]} parameters : @{parameter=System.Object[]} inputTypes : @{inputType=} returnValues : @{returnValue=} aliases : None
remarks : None alertSet : description : examples : Synopsis :
Get-SOSIDs [<CommonParameters>]
ModuleName : PS-StoreOnce nonTerminatingErrors : xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10 xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10 xmlns:maml : http://schemas.microsoft.com/maml/2004/10 Name : Get-SOSIDs Category : Function Component : Role : Functionality :
New Commands¶
This page contains details on New commands.
New-SOCatClient¶
- NAME
- New-SOCatClient
- SYNTAX
New-SOCatClient [-Server] <string> [-SOCatClientName] <string> [-SOCatClientPass] <string> [[-SOCatClientDesc] <string>] [[-Timeout] <int>] [<CommonParameters>]
New-SOCatClient [-Server] <string> [-SOCatClientCredential] <pscredential> [[-SOCatClientDesc] <string>] [[-Timeout] <int>] [<CommonParameters>]
- PARAMETERS
-SOCatClientCredential <pscredential>
-SOCatClientDesc <string>
-SOCatClientName <string>
-SOCatClientPass <string>
-Server <string>
-Timeout <int>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
- ALIASES
- None
- REMARKS
- None
New-SOCatStore¶
- NAME
- New-SOCatStore
- SYNTAX
- New-SOCatStore [-Server] <string> [-SSID] <string> [-SOCatStoreName] <string> [[-SOCatStoreDesc] <string>] [[-Timeout] <int>] [<CommonParameters>]
- PARAMETERS
-SOCatStoreDesc <string>
-SOCatStoreName <string>
-SSID <string>
-Server <string>
-Timeout <int>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
- ALIASES
- None
- REMARKS
- None
Remove Commands¶
This page contains details on Remove commands.
Remove-SOCatClient¶
- NAME
- Remove-SOCatClient
- SYNTAX
- Remove-SOCatClient [-Server] <string> [-SOCatClientName] <string> [[-Timeout] <int>] [<CommonParameters>]
- PARAMETERS
-SOCatClientName <string>
-Server <string>
-Timeout <int>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
- ALIASES
- None
- REMARKS
- None
Remove-SOCatStore¶
- NAME
- Remove-SOCatStore
- SYNTAX
- Remove-SOCatStore [-Server] <string> [-SSID] <string> [-SOCatStoreName] <string> [[-Timeout] <int>] [<CommonParameters>]
- PARAMETERS
-SOCatStoreName <string>
-SSID <string>
-Server <string>
-Timeout <int>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
- ALIASES
- None
- REMARKS
- None
Set Commands¶
This page contains details on Set commands.
Set-SOCatStoreAccess¶
- NAME
- Set-SOCatStoreAccess
- SYNTAX
- Set-SOCatStoreAccess [-Server] <string> [-SOCatClientName] <string> [-SOCatStoreName] <string> [-allowAccess] <bool> [<CommonParameters>]
- PARAMETERS
-SOCatClientName <string>
-SOCatStoreName <string>
-Server <string>
-allowAccess <bool>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
- ALIASES
- None
- REMARKS
- None
Test Commands¶
This page contains details on Test commands.
Test-IP¶
- NAME
- Test-IP
- SYNTAX
- Test-IP [-IP] <string> [[-Port] <int>] [<CommonParameters>]
- PARAMETERS
-IP <string>
-Port <int>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
- ALIASES
- None
- REMARKS
- None