Enter CteraServer - dfch/biz.dfch.PS.Storebox.Api GitHub Wiki

Enter-CteraServer

Performs a login to a StoreBox server.

Enter-CteraServer [-Uri] <String> [-Username] <String> [-Password] <String> [-Global] [<CommonParameters>]

Enter-CteraServer [-Uri] <String> [-Credential] <PSCredential> [-Global] [<CommonParameters>]

Performs a login to a StoreBox server.

For more information about Cmdlets see 'about_Functions_CmdletBindingAttribute'.

-Uri <String>
    URI of the StoreBox server.
    
    Required?                    true
    Position?                    1
    Default value                $biz_dfch_PS_Storebox_Api.UriPortal
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Username <String>
    Username with which to perform login.
    
    Required?                    true
    Position?                    2
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Password <String>
    Plaintext password with which to perform login.
    
    Required?                    true
    Position?                    3
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Credential <PSCredential>
    
    Required?                    true
    Position?                    2
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Global [<SwitchParameter>]
    
    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
<CommonParameters>
    This cmdlet supports the common parameters: Verbose, Debug,
    ErrorAction, ErrorVariable, WarningAction, WarningVariable,
    OutBuffer and OutVariable. For more information, see 
    about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 

See PARAMETER section for a description of input parameters.

For more information about input parameters see 'help about_Functions_Advanced_Parameters'.

This Cmdlet returns a WebRequestSession parameter. On failure the string contains $null.

For more information about output parameters see 'help about_Functions_OutputTypeAttribute'.

    Requires Powershell v3.
    
    Requires module 'biz.dfch.PS.System.Logging'.

C:\PS>Perform a login to a StoreBox server with username and plaintext password.


Enter-ServerDeprecated -Uri 'https://promo.ds01.swisscom.com' -Username 'PeterLustig' -Password 'S0nnensch3!n'

C:\PS>Perform a login to a StoreBox server with username and encrypted password.


Enter-ServerDeprecated -Uri 'https://promo.ds01.swisscom.com' -Credentials [PSCredentials]

Online Version: http://dfch.biz/PS/Storebox/Api/Enter-ServerDeprecated/

Exit-Ctera