Get-UalHyperV
Get-UalHyperV
Gets UAL information about virtual machines.
Syntax
Parameter Set: ByName
Get-UalHyperV [-AsJob] [-ChassisSerialNumber <String[]> ] [-CimSession <CimSession[]> ] [-FirstSeen <DateTime[]> ] [-LastSeen <DateTime[]> ] [-ProductName <String[]> ] [-RoleGuid <String[]> ] [-RoleName <String[]> ] [-ThrottleLimit <Int32> ] [-UUID <String[]> ] [ <CommonParameters>]
Detailed Description
The Get-UalHyperV cmdlet gets User Access Logging (UAL) information about virtual machines hosted on . Use the CimSession parameter to run the cmdlet on a remote server. Use this cmdlet only for servers that host virtual machines. UAL polls for data every 24 hours.
This cmdlet gets the virtual machine Universally Unique Identifier (UUID) for virtual machines hosted on a server, the name of the server product, and chassis serial number of the host server. This cmdlet also gets the creation time for a virtual machine and the most recent time the virtual machine ran on the server.
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 |
-ChassisSerialNumber<String[]>
Specifies an array of strings. Each member contains the chassis serial number of a server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-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 the virtual machine first existed.
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 the most recent time when UAL logged a virtual machine.
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 in the request is a component of this product.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-RoleGuid<String[]>
Specifies an array of GUIDs for roles that clients access.
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 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 |
-UUID<String[]>
Specifies an array of UUIDs for servers. Each UUID refers to the virtual machine.
Aliases |
none |
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, -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 information about virtual machines
This command gets UAL virtual machine records for the current server.
PS C:\> Get-UalHyperV