Clear-PcsvDeviceLog
Clears the System Event Log for a PCSV device.
Syntax
Clear-PcsvDeviceLog
[-TimeoutSec <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-PcsvDeviceLog
[-TargetAddress] <String>
[-Credential] <PSCredential>
[-ManagementProtocol] <ManagementProtocol>
[[-Port] <UInt16>]
[-Authentication <Authentication>]
[-UseSSL]
[-SkipCACheck]
[-SkipCNCheck]
[-SkipRevocationCheck]
[-TimeoutSec <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Clear-PcsvDeviceLog
-InputObject <CimInstance[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Clear-PcsvDeviceLog cmdlet clears the System Event Log for a Physical Computer System View (PCSV) device. This cmdlet currently supports devices that use the Intelligent Platform Management Interface (IPMI) protocol. You can use this cmdlet for both in-band and out-of-band connections. To use this cmdlet with an in-band connection, you must have elevated privileges.
Examples
Example 1: Clear the log for a device
PS C:\>$Credential = Get-Credential Admin
PS C:\> Clear-PcsvDeviceLog -TargetAddress "10.1.2.3" -Credential $Credential -ManagementProtocol IPMIThe first command uses the Get-Credential cmdlet to create a credential, and then stores it in the $Credential variable.
The cmdlet prompts you for a user name and password.
For more information, type Get-Help Get-Credential.
The second command clears the System Event Log for the device that has the specified IP address. The command uses the credential stored in $Credential.
Example 2: Clear the log for a device by using the pipeline
PS C:\>$Credential = Get-Credential Admin
PS C:\> Get-PcsvDevice -TargetAddress "10.1.2.3" -Credential $Credential -ManagementProtocol IPMI | Clear-PcsvDeviceLogThe first command uses Get-Credential to create a credential, and then stores it in the $Credential variable.
The second command uses the Get-PcsvDevice cmdlet to get the device that has the specified IP address. That cmdlet uses the credential stored in $Credential. The command passes that device to the current cmdlet by using the pipeline operator. The current cmdlet clears the System Event Log on that device.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authentication
Specifies an authentication method to use for devices managed by WS-Management. Do not specify this parameter for devices managed by using IPMI. The acceptable values for this parameter are:
- Basic
- Digest
- Default
| Type: | Authentication |
| Accepted values: | Default, Basic, Digest |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies a PSCredential object based on a user name and password.
To obtain a PSCredential object, use the Get-Credential cmdlet.
For more information, type Get-Help Get-Credential.
For IPMI devices, specify credentials that correspond to a user with Administrator privileges on the device.
| Type: | PSCredential |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ManagementProtocol
Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:
- WSMAN
- IPMI
This cmdlet currently supports only devices that use the IPMI protocol.
| Type: | ManagementProtocol |
| Aliases: | MP |
| Accepted values: | WSMan, IPMI |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Specifies a port on the remote computer to use for the management connection. If you do not specify a port, the cmdlet uses the following default ports:
- IPMI and WSMAN over HTTP. Port 623.
- WSMAN over HTTPS. Port 664.
| Type: | UInt16 |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipCACheck
Indicates that the client connects by using HTTPS without validating that a trusted certification authority (CA) signed the server certificate. Do not specify this parameter if you specify a value of IPMI for the ManagementProtocol parameter.
Do not specify this parameter unless you can establish trust in another way, such as if the remote computer is part of a network that is physically secure and isolated, or if the remote computer is a trusted host in a Windows Remote Management (WinRM) configuration.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipCNCheck
Indicates that the certificate common name (CN) of the server does not need to match the host name of the server. Do not specify this parameter if you specify a value of IPMI for the ManagementProtocol parameter.
Specify this parameter only for managing devices by using WSMAN over HTTPS. Be sure to specify this parameter only for trusted computers.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipRevocationCheck
Indicates that the cmdlet skips the revocation check of server certificates.
Be sure to specify this parameter only for trusted computers.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TargetAddress
Specifies the name or IP address of the remote hardware device.
| Type: | String |
| Aliases: | CN, ComputerName, IpAddress |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeoutSec
Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection attempt.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UseSSL
Indicates that the server connects to the target computer by using SSL. WSMAN encrypts all content transmitted over the network. Specify this parameter to use the additional protection of HTTPS instead of HTTP. If you specify this parameter and SSL is not available on the connection port, the command fails.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PcsvDevice.ManagementProtocol
Microsoft.PowerShell.Cmdletization.GeneratedTypes.PcsvDevice.Authentication
Outputs
This cmdlet returns a PCSV device object, if you specify the PassThru parameter.
Notes
- This cmdlet clears the System Event Log. For devices that support the IPMI Reserve SEL command, the cmdlet first tries to make a SEL reservation. If the reservation becomes invalid due to a more recent event, the cmdlet fails. If the cmdlet fails, try again.