< Back
Get-ControlSessions
Post
NAME Get-ControlSessions
SYNOPSIS
Gets bulk session info from Control using the Automate Control Reporting Extension
SYNTAX
Get-ControlSessions [[-SessionID] <Guid[]>] [<CommonParameters>]
DESCRIPTION
Gets bulk session info from Control using the Automate Control Reporting Extension
PARAMETERS
-SessionID <Guid[]>
The GUID identifier(s) for the machine you want status information on. If not provided, all sessions will be
returned.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
OUTPUTS
Custom object of session details for all sessions
NOTES
Version: 1.4
Author: Gavin Stone
Modified By: Darren White
Purpose/Change: Initial script development
Update Date: 2019-02-23
Author: Darren White
Purpose/Change: Added SessionID parameter to return information only for requested sessions.
Update Date: 2019-02-26
Author: Darren White
Purpose/Change: Include LastConnected value if reported.
Update Date: 2019-06-24
Author: Darren White
Purpose/Change: Modified output to be collection of objects instead of a hastable.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ControlSesssions
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-CredentialsLocallyStored; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-CredentialsLocallyStored [-Automate] [-CredentialDirectory <string>]
[<CommonParameters>]
Get-CredentialsLocallyStored [-Control] [-CredentialDirectory <string>] [<CommonParameters>]
Get-CredentialsLocallyStored [-All] [<CommonParameters>]
Get-CredentialsLocallyStored -CredentialPath <string> [<CommonParameters>]
ModuleName : AutomateAPI
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-CredentialsLocallyStored
Category : Function
Component :
Role :
Functionality :
SYNOPSIS
Gets bulk session info from Control using the Automate Control Reporting Extension
SYNTAX
Get-ControlSessions [[-SessionID] <Guid[]>] [<CommonParameters>]
DESCRIPTION
Gets bulk session info from Control using the Automate Control Reporting Extension
PARAMETERS
-SessionID <Guid[]>
The GUID identifier(s) for the machine you want status information on. If not provided, all sessions will be
returned.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
OUTPUTS
Custom object of session details for all sessions
NOTES
Version: 1.4
Author: Gavin Stone
Modified By: Darren White
Purpose/Change: Initial script development
Update Date: 2019-02-23
Author: Darren White
Purpose/Change: Added SessionID parameter to return information only for requested sessions.
Update Date: 2019-02-26
Author: Darren White
Purpose/Change: Include LastConnected value if reported.
Update Date: 2019-06-24
Author: Darren White
Purpose/Change: Modified output to be collection of objects instead of a hastable.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-ControlSesssions
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Get-CredentialsLocallyStored; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Get-CredentialsLocallyStored [-Automate] [-CredentialDirectory <string>]
[<CommonParameters>]
Get-CredentialsLocallyStored [-Control] [-CredentialDirectory <string>] [<CommonParameters>]
Get-CredentialsLocallyStored [-All] [<CommonParameters>]
Get-CredentialsLocallyStored -CredentialPath <string> [<CommonParameters>]
ModuleName : AutomateAPI
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Get-CredentialsLocallyStored
Category : Function
Component :
Role :
Functionality :