< Back

New-LimeSession

Sat Jan 18, 2020 9:44 am

NAME New-LimeSession



SYNOPSIS

Connects to LimeSurvey Server and returns a Session Key.





SYNTAX

New-LimeSession [[-Credential] <PSCredential>] [[-BaseUri] <String>] [<CommonParameters>]





DESCRIPTION

Connects to LimeSurvey Server and returns a Session Key so that other LimeSurvey-XML commands can be authenticated

when using the -Session paramenter





PARAMETERS

-Credential <PSCredential>

A credential to use for LimeSurvey.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-BaseUri <String>

Base URI for LimeSurvey.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Microsoft.PowerShell.System.String





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$MyLimeSession = New-LimeSession -Credential (Get-Credential) -BaseUri

"https://host.com/limesurvey/index.php?r ... otecontrol"















RELATED LINKS