Restart-CapaAgent
Restart-CapaAgent
SYNOPSIS
Sets an action to restart an agent.
SYNTAX
__AllParameterSets
Restart-CapaAgent [-CapaSDK] <Object> [-UnitName] <string> [-UnitType] <string> [<CommonParameters>]
ALIASES
This cmdlet has the following aliases,
DESCRIPTION
Sets an action to restart an agent. If a user is specified, the agent on the computers linked to the user will be restarted.
EXAMPLES
EXAMPLE 1
Restart-CapaAgent -CapaSDK $CapaSDK -UnitName ‘TestComputer’ -UnitType ‘Computer’
PARAMETERS
-CapaSDK
The CapaSDK object.
Type: System.Object
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-UnitName
The name of the unit.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 1
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-UnitType
The type of the unit. This can be either “Computer” or “User”
Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
Position: 2
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
For more information, see https://capasystems.atlassian.net/wiki/spaces/CI64DOC/pages/19306247696/Restart+Agent+using+SDK