Get CteraEntity - dfch/biz.dfch.PS.Storebox.Api GitHub Wiki

Get-CteraEntity

Gets Storebox Portals from currently selected Portal on a given UriPortal.

Get-CteraEntity [[-PortalName] <String>] [[-Entity] <String>] [[-Session] <Hashtable>] [[-ReturnAsXml]] [<CommonParameters>]

Gets Storebox Portals from currently selected Portal on a given UriPortal.

For more information about Cmdlets see 'about_Functions_CmdletBindingAttribute'.

-PortalName <String>
    The name of a Storebox Portal to select.
    
    Required?                    false
    Position?                    2
    Default value                $biz_dfch_PS_Storebox_Api.PortalName
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Entity <String>
    
    Required?                    false
    Position?                    1
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-Session <Hashtable>
    
    Required?                    false
    Position?                    3
    Default value                $biz_dfch_PS_Storebox_Api.Session
    Accept pipeline input?       false
    Accept wildcard characters?  false
    
-ReturnAsXml [<SwitchParameter>]
    
    Required?                    false
    Position?                    4
    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 an XML document 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.


Get-Entity -UriPortal 'https://promo.ds01.swisscom.com' -Username 'PeterLustig' -Password 'S0nnensch3!n'

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


Get-Entity -UriPortal 'https://promo.ds01.swisscom.com' -Username 'PeterLustig' -Credentials [PSCredentials]

Online Version: http://dfch.biz/PS/Storebox/Api/Get-Entity/
Enter-Ctera