New-St2ClientConnection
SYNOPSIS
Create a new connection to a StackStorm (St2) API endpoint.
SYNTAX
New-St2ClientConnection -Username <String> -Password <String> [-Name <String>] -ApiUrl <String> -AuthApiUrl <String> [-IgnoreCertificateValidation [<SwitchParameter>]] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
DESCRIPTION
Create a new connection to a StackStorm (St2) API endpoint by authenticating with a username/password credential and gathering an OAuth token to use in subsequent requests. Connections will be saved to the current session so you do not need to specify the -Connection parameter with each request.
PARAMETERS
-Username <String>
The username to authenticate with StackStorm
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <String>
The password to authenticate with StackStorm
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of your connection (optional)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApiUrl <String>
The URL of the API, typically http(s)://(ip):9101/
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthApiUrl <String>
The URL of the Authentication API, typically http(s)://(ip):9100/
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction <ActionPreference>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InformationVariable <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IgnoreCertificateValidation <SwitchParameter>
Ignore certificate validation (e.g. using the default self-signed certificate)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false