< Back
Get-AutomateControlInfo
Post
NAME Get-AutomateControlInfo
SYNOPSIS
Retrieve data from Automate API Control Extension
SYNTAX
Get-AutomateControlInfo [-ComputerID] <Int16[]> [<CommonParameters>]
Get-AutomateControlInfo -ID <Int16[]> -ComputerObjects <Object> [<CommonParameters>]
DESCRIPTION
Connects to the Automate API Control Extension and returns an object with Control Session data
PARAMETERS
-ComputerID <Int16[]>
The Automate ComputerID to retrieve information on
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ID <Int16[]>
Taken from the Pipeline, IE Get-AutomateComputer -ComputerID 5 | Get-AutomateControlInfo
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ComputerObjects <Object>
Used for Pipeline input from Get-AutomateComputer
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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
Custom object with the ComputerID and Control SessionID. Additional properties from the return data will be
included.
NOTES
Version: 1.0
Author: Gavin Stone
Creation Date: 2019-01-20
Purpose/Change: Initial script development
Update Date: 2019-02-12
Author: Darren White
Purpose/Change: Modified returned object data
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-AutomateControlInfo -ComputerId 123
RELATED LINKS
SYNOPSIS
Retrieve data from Automate API Control Extension
SYNTAX
Get-AutomateControlInfo [-ComputerID] <Int16[]> [<CommonParameters>]
Get-AutomateControlInfo -ID <Int16[]> -ComputerObjects <Object> [<CommonParameters>]
DESCRIPTION
Connects to the Automate API Control Extension and returns an object with Control Session data
PARAMETERS
-ComputerID <Int16[]>
The Automate ComputerID to retrieve information on
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ID <Int16[]>
Taken from the Pipeline, IE Get-AutomateComputer -ComputerID 5 | Get-AutomateControlInfo
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ComputerObjects <Object>
Used for Pipeline input from Get-AutomateComputer
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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
Custom object with the ComputerID and Control SessionID. Additional properties from the return data will be
included.
NOTES
Version: 1.0
Author: Gavin Stone
Creation Date: 2019-01-20
Purpose/Change: Initial script development
Update Date: 2019-02-12
Author: Darren White
Purpose/Change: Modified returned object data
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-AutomateControlInfo -ComputerId 123
RELATED LINKS