HelpCache/MsftUal_UserAccess.cdxml-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-UalUserAccess</command:name><maml:description><maml:para>Gets UAL records of client requests per user.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>UalUserAccess</command:noun><dev:version /></command:details><maml:description><maml:para>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. </maml:para><maml:para>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.</maml:para><maml:para>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.</maml:para><maml:para>For more information about UAL, see the <maml:navigationLink><maml:linkText>User Access Logging Overview</maml:linkText><maml:uri></maml:uri></maml:navigationLink> topic in the TechNet library at http://technet.microsoft.com/library/hh849634.aspx.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-UalUserAccess</maml:name><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ActivityCount</maml:name><maml:description><maml:para>Specifies an array of the number of access requests by a client for a service.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">UInt32[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>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 <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>FirstSeen</maml:name><maml:description><maml:para>Specifies an array of dates, as DateTime objects. A time represents when the client accessed the service for the first time.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">DateTime[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>LastSeen</maml:name><maml:description><maml:para>Specifies an array of dates, as DateTime objects. A time represents when the client most recently accessed the service.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">DateTime[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ProductName</maml:name><maml:description><maml:para>Specifies an array of names of products. The installed role or specific product in the request is a component of this product.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RoleGuid</maml:name><maml:description><maml:para>Specifies an array of GUIDs for roles that clients access. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RoleName</maml:name><maml:description><maml:para>Specifies an array of names for roles that clients access. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>TenantIdentifier</maml:name><maml:description><maml:para>Specifies an array of GUIDs. Each GUID identifies a tenant client of an installed role or product, if a tenant client exists.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Username</maml:name><maml:description><maml:para>Specifies an array of user names that request a service. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ActivityCount</maml:name><maml:description><maml:para>Specifies an array of the number of access requests by a client for a service.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">UInt32[]</command:parameterValue><dev:type><maml:name>UInt32[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CimSession</maml:name><maml:description><maml:para>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 <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>FirstSeen</maml:name><maml:description><maml:para>Specifies an array of dates, as DateTime objects. A time represents when the client accessed the service for the first time.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">DateTime[]</command:parameterValue><dev:type><maml:name>DateTime[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>LastSeen</maml:name><maml:description><maml:para>Specifies an array of dates, as DateTime objects. A time represents when the client most recently accessed the service.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">DateTime[]</command:parameterValue><dev:type><maml:name>DateTime[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ProductName</maml:name><maml:description><maml:para>Specifies an array of names of products. The installed role or specific product in the request is a component of this product.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RoleGuid</maml:name><maml:description><maml:para>Specifies an array of GUIDs for roles that clients access. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>RoleName</maml:name><maml:description><maml:para>Specifies an array of names for roles that clients access. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>TenantIdentifier</maml:name><maml:description><maml:para>Specifies an array of GUIDs. Each GUID identifies a tenant client of an installed role or product, if a tenant client exists.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Username</maml:name><maml:description><maml:para>Specifies an array of user names that request a service. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Get access information for a specific user</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>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 : </dev:code><dev:remarks><maml:para>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.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Get-UalDailyAccess</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-UalDailyDeviceAccess</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-UalDailyUserAccess</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-UalDeviceAccess</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |