Edit

Share via


Get-UalHyperV

Gets UAL information about virtual machines.

Syntax

Default (Default)

Get-UalHyperV
    [-ProductName <String[]>]
    [-RoleName <String[]>]
    [-RoleGuid <String[]>]
    [-UUID <String[]>]
    [-ChassisSerialNumber <String[]>]
    [-FirstSeen <DateTime[]>]
    [-LastSeen <DateTime[]>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-UalHyperV cmdlet gets User Access Logging (UAL) information about virtual machines hosted on Microsoft® Hyper-V® Server 2016. Use the CimSession parameter to run the cmdlet on a remote server. Use this cmdlet only for servers that host virtual machines. UAL polls Hyper-V Server 2016 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 Hyper-V Server 2016 server.

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 information about virtual machines

PS C:\>Get-UalHyperV

This command gets UAL virtual machine records for the current server.

Parameters

-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

-ChassisSerialNumber

Specifies an array of strings. Each member contains the chassis serial number of a server.

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

-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 virtual machine first existed.

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 the most recent time when UAL logged a virtual machine.

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 client's 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 client's 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

-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

-UUID

Specifies an array of UUIDs for servers. Each UUID refers to the virtual machine.

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.