Get-UalOverview
Get-UalOverview
Gets information about products registered with UAL.
Syntax
Parameter Set: ByName
Get-UalOverview [-AsJob] [-CimSession <CimSession[]> ] [-FirstSeen <DateTime[]> ] [-GUID <String[]> ] [-LastSeen <DateTime[]> ] [-ProductName <String[]> ] [-RoleName <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-UalOverview cmdlet gets information about products registered with User Access Logging (UAL) on a server. Use the CimSession parameter to run the cmdlet on a remote server.
This cmdlet returns records that specify a server role and the name of the server product. Each record also includes the first time a client accessed the service and a most recent time a client accessed the service. Only server roles that have data for first client request and most recent client request provide records for this cmdlet.
You can specify parameter values to narrow the records that this cmdlet returns. For instance, you can get records for only a specified role.
For more information about UAL, see the User Access Logging Overview topic in the TechNet library at https://technet.microsoft.com/library/hh849634.aspx.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FirstSeen<DateTime[]>
Specifies an array of dates, as DateTime objects. A time represents when a client accessed the service for the first time.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-GUID<String[]>
Specifies an array of GUIDs for roles that clients can access.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LastSeen<DateTime[]>
Specifies an array of dates, as DateTime objects. A time represents when a client accessed the service for the most recent time.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ProductName<String[]>
Specifies an array of names of products. The installed role or specific product is a component of this product.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-RoleName<String[]>
Specifies an array of names for roles that clients can access.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get overview information
This command gets an overview record for the DHCP Server role on the local system.
PS C:\> Get-UalOverview -RoleName "DHCP Server"