Get-LXCOEvents
This cmdlet returns a list of events or information about a specific event.
Syntax
Get-LXCOEvents [-Connection LXCOConnection]
-ID String
[CommonParameter]
Get-LXCOEvents [-Connection LXCOConnection]
-ResourceEvents
[-Severity String[]]
[-Serviceability String[]]
[-Message String]
[-ResourceName String]
[-ResourceType String[]]
[-GroupName String]
[-EventId String]
[-EventDate String[]]
[CommonParameter]
Get-LXCOEvents [-Connection LXCOConnection]
-ResourceEvents
-Excluded
[-Message String]
[-ResourceName String]
[-EventId String]
[-EventDate String[]]
[CommonParameter]
Get-LXCOEvents [-Connection LXCOConnection]
-AuditEvents
[-Severity String[]]
[-Serviceability String[]]
[-Message String]
[-ResourceName String]
[-ResourceType String[]]
[-GroupName String]
[-EventId String]
[-EventDate String[]]
[-UserName String]
[CommonParameter]
Get-LXCOEvents [-Connection LXCOConnection]
-AuditEvents
-Excluded
[-Message String]
[-ResourceName String]
[-EventId String]
[-EventDate 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.
- -ID String
- Specifies the ID of the event to return.
- -ResourceEvents
- When specified, this cmdlet returns a list of resource events.
- -Severity String[]
- Specifies a comma-separated list of severities. This can be one or more of the following values.
- Informational. Information only. No action is necessary.
- Warning. User can decide if action is needed.
- Critical. Action is needed immediately, and the scope is broad (perhaps an imminent outage to a critical resource will result).
- -Serviceability String[]
- Specifies a comma-separated list of serviceabilities. This can be one or more of the following values.
- None. (default). Not serviceable.
- Serviceable. Serviceable by Lenovo. If Call Home is configured, service ticket is opened with the Lenovo Support Center, and service data is collected and sent for the device, resource manager, and XClarity Orchestrator.
- Unknown. Serviceability is not known
- User. Serviceable by the user
- -Message String
- Specifies the full or partial message text. All events that contain the specified pattern are returned.
- -ResourceName String
- Specifies the full or partial resource name. All events that contain the specified pattern are returned.
- -ResourceType String[]
Specifies a comma-separated list of resource types. This can be one or more of the following values.
- Chassis
- XClarityAdministrator
- XClarityManagementHub2_0
- XClarityOrchestrator
- Server
- Storage
- Switch
- -GroupName String
- Specifies a comma-separated list of full or partial resource-group name. All alerts that contain one or more the specified patterns are returned.
- -EventId String
- Specifies the full or partial event code. All events that contain the specified pattern are returned.
- -EventDate String[]
- Specifies the event dates as range, using the following format: {startDate},{endDate}. The end date is optional. If is not specified, the current date is used by default.
- -Excluded
- When specified, this cmdlet returns a list of excluded events.
- -AuditEvents
- When specified, this cmdlet returns a list of audit events.
- -UserName String
- Specifies the full or partial username. All events that contain the specified pattern are returned.
- 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.Alerts.EventData[]
If -ID is not specified, this cmdlet returns an array of EventData objects that contains high-level information for each event.
- Lenovo.XClarityOrchestrator.PowerShell.Data.Alerts.EventFullData
If -ID is specified, this cmdlet returns an EventFullData object that contains detailed information about a specific event.
- Lenovo.XClarityOrchestrator.PowerShell.Data.RequestStatusMessage
If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.
Examples
The following example returns information about all audit events.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$result = Get-LXCOEvents -AuditEvents
$result|Format-List
Disconnect-LXCO
The following example returns information about all excluded resource events.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$result = Get-LXCOEvents -ResourceEvents -Excluded
$result|Format-List
Disconnect-LXCO
The following example returns a detailed information about a specific event.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$result = Get-LXCOEvents -ID 0X806F06080A01FF03
$result
Disconnect-LXCO
The following example returns the not excluded resource events, which meet the specified filtering criterion.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred -SkipCertificateCheck
$result = Get-LXCOEvents -ResourceEvents `
-EventDate "1.10.2022 14:30:00","1.12.2022 11:45:00" `
-EventId FD243 `
-GroupName GRP `
-ResourceType Server `
-Serviceability User `
-Severity Critical
$result|Format-List
Disconnect-LXCO