Get-UalUserAccess
Gets UAL records of client requests per user.
Syntax
Default (Default)
Get-UalUserAccess
[-ProductName <String[]>]
[-RoleName <String[]>]
[-RoleGuid <String[]>]
[-TenantIdentifier <String[]>]
[-Username <String[]>]
[-ActivityCount <UInt32[]>]
[-FirstSeen <DateTime[]>]
[-LastSeen <DateTime[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
Description
The Get-UalUserAccess cmdlet gets User Access Logging (UAL) records for client requests, by user, for services on a server. Use the CimSession parameter to run the cmdlet on a remote server.
This cmdlet organizes information by user. For each user that accesses a service on a server, the cmdlet returns a record that specifies the user, the server role that the client requested, and the name of the server product. If the service uses a tenant client, the record includes a tenant identifier. The record also includes the first time the client accessed the service, the most recent time the client accessed the service, and the total number of times the client accessed the service.
You can specify parameter values to narrow the records that this cmdlet returns. For instance, you can get records for only a specified user or role.
For more information about UAL, see the User Access Logging Overview topic in the TechNet library at http://technet.microsoft.com/library/hh849634.aspx.
Examples
Example 1: Get access information for a specific user
PS C:\>Get-UalUserAccess -Username "western\sarahjones"
ActivityCount : 30
FirstSeen : 8/22/2012 12:15:35 AM
LastSeen : 9/29/2012 10:41:46 AM
ProductName : Windows Server 2012 Datacenter
RoleGuid : 10a9226f-50ee-49d8-a393-9a501d47ce04
RoleName : File Server
TenantIdentifier : 00000000-0000-0000-0000-000000000000
UserName : western\sarahjones
PSComputerName :
This command gets the UAL records for a client user with a specified name. The results show a single service that the user accesses for the first time on 8/22/2012 and most recently on 9/29/2012.
Parameters
-ActivityCount
Specifies an array of the number of access requests by a client for a service.
Parameter properties
| Type: | UInt32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FirstSeen
Specifies an array of dates, as DateTime objects. A time represents when the client accessed the service for the first time.
Parameter properties
| Type: | DateTime[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-LastSeen
Specifies an array of dates, as DateTime objects. A time represents when the client most recently accessed the service.
Parameter properties
| Type: | DateTime[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ProductName
Specifies an array of names of products. The installed role or specific product in the request is a component of this product.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-RoleGuid
Specifies an array of GUIDs for roles that clients access.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-RoleName
Specifies an array of names for roles that clients access.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-TenantIdentifier
Specifies an array of GUIDs. Each GUID identifies a tenant client of an installed role or product, if a tenant client exists.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Username
Specifies an array of user names that request a service.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.