Remove-LXCAJobNotes

This cmdlet removes all notes from a specific job (task).

Note: You cannot pipe objects to this cmdlet.

Syntax

Remove-LXCAJobNotes [-Connection LXCAConnection] 
                     -JobUID String
                    [CommonParameter]

Parameters

-Connection LXCAConnection
Specifies the connection to the Lenovo XClarity Administrator server. If no connection is specified, the result from the last Connect-LXCA cmdlet is used.
-JobUID String
Specifies the UID of the job.

If specified job does not exist, the 404 - Not Found exception is thrown.

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

This cmdlet does not return data.

Examples

The following example retrieves information about all job schedules

$cred = Get-Credential
Connect-LXCA -Host 192.0.2.0 -Credential $cred

$jobUID = 123444
Remove-LXCAJobNotes -JobUID $jobUID

Disconnect-LXCA