< Back
New-AtlassianSession
Post
NAME New-AtlassianSession
SYNOPSIS
Initialises a new AtlassianSession
SYNTAX
New-AtlassianSession [-Server] <String> [-Credential] <PSCredential> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-AtlassianSession cmdlet creates a new AtlassianSession object.
If no current AtlassianSession is saved in the custom session variable (name specified in settings.xml) the newly
created AtlassianSession will be saved in this variable.
If the custom session variable already has a value you will be prompted whether or not you want to replace it.
PARAMETERS
-Server <String>
Specifies the Server URL to be used for the session.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the Credentials to be used for the session.
Required? true
Position? 2
Default value (Get-Credential -Message "Enter Atlassian user credentials")
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
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
None
You cannot pipe input to this cmdlet.
OUTPUTS
AtlassianSession
Returns the newly created AtlassianSession object. (even if it is not saved)
NOTES
The AtlassianSession object has a Save(<Path>) method that can be called to save an encrypted session file to
disk.
Encrypted session files can only be used by the same user account.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-AtlassianSession -Server 'http://localhost:2990/jira'
Creates a new AtlassianSession that connects to the jira test environment running on your localhost.
Credentials will be prompted.
RELATED LINKS
SYNOPSIS
Initialises a new AtlassianSession
SYNTAX
New-AtlassianSession [-Server] <String> [-Credential] <PSCredential> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-AtlassianSession cmdlet creates a new AtlassianSession object.
If no current AtlassianSession is saved in the custom session variable (name specified in settings.xml) the newly
created AtlassianSession will be saved in this variable.
If the custom session variable already has a value you will be prompted whether or not you want to replace it.
PARAMETERS
-Server <String>
Specifies the Server URL to be used for the session.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the Credentials to be used for the session.
Required? true
Position? 2
Default value (Get-Credential -Message "Enter Atlassian user credentials")
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
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
None
You cannot pipe input to this cmdlet.
OUTPUTS
AtlassianSession
Returns the newly created AtlassianSession object. (even if it is not saved)
NOTES
The AtlassianSession object has a Save(<Path>) method that can be called to save an encrypted session file to
disk.
Encrypted session files can only be used by the same user account.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-AtlassianSession -Server 'http://localhost:2990/jira'
Creates a new AtlassianSession that connects to the jira test environment running on your localhost.
Credentials will be prompted.
RELATED LINKS