< Back
Clear-PcsvDeviceLog
Post
NAME Clear-PcsvDeviceLog
SYNOPSIS
Clears the System Event Log for a PCSV device.
SYNTAX
Clear-PcsvDeviceLog [-TargetAddress] <String> [-Credential] <PSCredential> [-ManagementProtocol] {WSMan | IPMI} [[-Port] <UInt16>] [-Authentication
{Default | Basic | Digest}] [-CimSession <CimSession[]>] [-PassThru] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-ThrottleLimit <Int32>]
[-TimeoutSec <UInt32>] [-UseSSL] [<CommonParameters>]
Clear-PcsvDeviceLog [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-TimeoutSec <UInt32>] [<CommonParameters>]
Clear-PcsvDeviceLog [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [<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.
PARAMETERS
-Authentication [<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:The acceptable values for this parameter are:
-- Basic
-- Digest
-- Default
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
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.
Required? true
Position? 3
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ManagementProtocol <ManagementProtocol>
Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:The acceptable values for this
parameter are:
-- WSMAN
-- IPMI
This cmdlet currently supports only devices that use the IPMI protocol.
Required? true
Position? 4
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
passthru
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Port [<UInt16>]
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.
Required? false
Position? 5
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCACheck [<SwitchParameter>]
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 ManagmentProtocol 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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCNCheck [<SwitchParameter>]
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 ManagmentProtocol parameter.
Specify this parameter only for managing devices by using WSMAN over HTTPS. Be sure to specify this parameter only for trusted computers.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipRevocationCheck [<SwitchParameter>]
Indicates that the cmdlet skips the revocation check of server certificates.
Be sure to specify this parameter only for trusted computers.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-TargetAddress <String>
Specifies the name or IP address of the remote hardware device.
Required? true
Position? 2
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSec [<UInt32>]
Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection
attempt.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-UseSSL [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
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
Microsoft.Management.Infrastructure.CimInstance,
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/HardwareManagement/MSFT_PCSVDevice
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.
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 IPMI
The 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-PcsvDeviceLog
The 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.
RELATED LINKS
Get-PcsvDeviceLog
Get-PcsvDevice
SYNOPSIS
Clears the System Event Log for a PCSV device.
SYNTAX
Clear-PcsvDeviceLog [-TargetAddress] <String> [-Credential] <PSCredential> [-ManagementProtocol] {WSMan | IPMI} [[-Port] <UInt16>] [-Authentication
{Default | Basic | Digest}] [-CimSession <CimSession[]>] [-PassThru] [-SkipCACheck] [-SkipCNCheck] [-SkipRevocationCheck] [-ThrottleLimit <Int32>]
[-TimeoutSec <UInt32>] [-UseSSL] [<CommonParameters>]
Clear-PcsvDeviceLog [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-TimeoutSec <UInt32>] [<CommonParameters>]
Clear-PcsvDeviceLog [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [<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.
PARAMETERS
-Authentication [<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:The acceptable values for this parameter are:
-- Basic
-- Digest
-- Default
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-CimSession [<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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
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.
Required? true
Position? 3
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ManagementProtocol <ManagementProtocol>
Specifies a management protocol used to communicate with a device. The acceptable values for this parameter are:The acceptable values for this
parameter are:
-- WSMAN
-- IPMI
This cmdlet currently supports only devices that use the IPMI protocol.
Required? true
Position? 4
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
passthru
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Port [<UInt16>]
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.
Required? false
Position? 5
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCACheck [<SwitchParameter>]
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 ManagmentProtocol 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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipCNCheck [<SwitchParameter>]
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 ManagmentProtocol parameter.
Specify this parameter only for managing devices by using WSMAN over HTTPS. Be sure to specify this parameter only for trusted computers.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-SkipRevocationCheck [<SwitchParameter>]
Indicates that the cmdlet skips the revocation check of server certificates.
Be sure to specify this parameter only for trusted computers.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-TargetAddress <String>
Specifies the name or IP address of the remote hardware device.
Required? true
Position? 2
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit [<Int32>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutSec [<UInt32>]
Specifies how long to wait, in seconds, for a response from the remote hardware device. After this period, the cmdlet abandons the connection
attempt.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-UseSSL [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
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
Microsoft.Management.Infrastructure.CimInstance,
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/HardwareManagement/MSFT_PCSVDevice
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.
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 IPMI
The 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-PcsvDeviceLog
The 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.
RELATED LINKS
Get-PcsvDeviceLog
Get-PcsvDevice