Get-UalSystemId
Get-UalSystemId
Gets information that can uniquely identify a server.
Syntax
Parameter Set: ByName
Get-UalSystemId [-AsJob] [-CimSession <CimSession[]> ] [-CoresPerPhysicalProcessor <UInt32[]> ] [-CreationTime <DateTime[]> ] [-LogicalProcessorsPerPhysicalProcessor <UInt32[]> ] [-MaximumMemory <UInt64[]> ] [-OSBuildNumber <UInt32[]> ] [-OSCountryCode <String[]> ] [-OSCurrentTimeZone <Int16[]> ] [-OSDaylightInEffect <Boolean[]> ] [-OSLastBootUpTime <DateTime[]> ] [-OSMajor <UInt32[]> ] [-OSMinor <UInt32[]> ] [-OSPlatformId <UInt32[]> ] [-OSProductType <UInt32[]> ] [-OSSerialNumber <String[]> ] [-OSSuiteMask <UInt32[]> ] [-PhysicalProcessorCount <UInt32[]> ] [-ServicePackMajor <UInt32[]> ] [-ServicePackMinor <UInt32[]> ] [-SystemDNSHostName <String[]> ] [-SystemDomainName <String[]> ] [-SystemManufacturer <String[]> ] [-SystemProductName <String[]> ] [-SystemSerialNumber <String[]> ] [-SystemSMBIOSUUID <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-UalSystemId cmdlet gets information that can uniquely identify a server. Use the CimSession parameter to run the cmdlet on a remote server. Otherwise, the cmdlet refers to the local server.
This cmdlet returns an MsftUal_SystemId object. You can specify one or more parameters, such as the CoresPerPhysicalProcessor parameter. If you do so, the cmdlet only returns an object if it matches the specified value.
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 |
-CoresPerPhysicalProcessor<UInt32[]>
Specifies an array of values. Each value specifies the number of cores for the physical processor of the system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-CreationTime<DateTime[]>
Specifies an array of DateTime objects. Each object is the date and time that the current operating system became operational with this set of system identity properties. If the properties of a system change, the operating system creates a new MsftUal_SystemId object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LogicalProcessorsPerPhysicalProcessor<UInt32[]>
Specifies an array of values. Each value specifies the number of logical processors for an instance of a Hyper-Thread capable physical processor in the system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MaximumMemory<UInt64[]>
Specifies an array of values. Each value represents the maximum memory size, in bytes, for the system. For a virtual machine, this value represents the memory size of the virtual machine as configured by the hypervisor. .
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSBuildNumber<UInt32[]>
Specifies an array of values. Each value represents the build number for the operating system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSCountryCode<String[]>
Specifies an array of strings. Each value is a code for the country or region that an operating system uses, based on international phone prefixes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-OSCurrentTimeZone<Int16[]>
Specifies an array of values. Each value represents an offset, in minutes, between the operating system time and Greenwich Mean Time (GMT). The value can be positive, negative, or zero.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSDaylightInEffect<Boolean[]>
Specifies an array of Boolean values. If a value is $True, daylight saving time is in effect.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSLastBootUpTime<DateTime[]>
Specifies an array of DateTime objects. A value represents the last time the operating system was restarted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSMajor<UInt32[]>
Specifies an array of values. Each value represents the major portion of the version number of an operating system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSMinor<UInt32[]>
Specifies an array of values. Each value represents the minor portion of the version number of an operating system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSPlatformId<UInt32[]>
Specifies an array of values. Each value represents an operating system platform. The acceptable values for this parameter are:
-- 1. An unsupported Windows system.
-- 2. A supported Windows system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSProductType<UInt32[]>
Specifies an array of values. Each value represents an operating system product type. The acceptable values for this parameter are:
-- 1. Standard Edition of a server product.
-- 2. Enterprise Edition of a server product.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OSSerialNumber<String[]>
Specifies an array of strings. Each string is an operating system product serial number.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-OSSuiteMask<UInt32[]>
Specifies an array of values. Each value represents the suite mask for an system. A suite mask is a combination of bit flags that identify the product suites available on the system.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PhysicalProcessorCount<UInt32[]>
Specifies an array of values. Each value represents the number of physical processors available on the local system. This number does not include the disabled processors.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServicePackMajor<UInt32[]>
Specifies an array of values. Each value represents the major portion of the version number of a service pack.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServicePackMinor<UInt32[]>
Specifies an array of values. Each value represents the minor portion of the version number of a service pack.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SystemDNSHostName<String[]>
Specifies an array of strings. Each string is a server name according to the Domain Name System (DNS) server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-SystemDomainName<String[]>
Specifies an array of strings. Each sting is the name of the domain or workgroup that the server belongs to.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SystemManufacturer<String[]>
Specifies an array of strings. Each string represents the name of the BIOS manufacturer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-SystemProductName<String[]>
Specifies an array of strings. Each string represents the product name specified in the system BIOS.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-SystemSerialNumber<String[]>
Specifies an array of strings. Each string represents a unit identification for a server.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-SystemSMBIOSUUID<String[]>
Specifies an array of strings. Each string represents the universally unique identifier (UUID) for this server unit as reported by the SMBIOS.
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 system information
This command gets an MsftUal_SystemId object for the current system.
PS C:\> Get-UalSystemId