Remove-LXCOJob
This cmdlet removes an existing job or cancels an existing schedule that is in the Pending state.
Note
You cannot pipe objects to this cmdlet.
Syntax
Remove-LXCOJob [-Connection LXCOConnection]
-JobID String
[CommonParameter]
Remove-LXCOJob [-Connection LXCOConnection]
-ScheduleID String
[CommonParameter]
Parameters
- -Connection LXCOConnection
- Specifies the connection to the Lenovo XClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.
- -JobID String
- Specifies the ID of the job to be removed.
- -ScheduleID String
- Specifies the ID of the schedule to be canceled.
- CommonParameters
- This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.
Results
- Lenovo.XClarityOrchestrator.PowerShell.Data.StatusMessage
This cmdlet returns a StatusMessage object that contains information about the request result.
Examples
The following example removes specified job.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$result = Remove-LXCOJob -JobID "135"
$result
Disconnect-LXCO
The following example cancels specified schedule.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$result = Remove-LXCOJob -ScheduleID "3f32cd9a44584a3ca1bfd215a646ca05"
$result
Disconnect-LXCO
Give documentation feedback