Get-UalSystemId
Gets information that can uniquely identify a server.
Syntax
Default (Default)
Get-UalSystemId
[-PhysicalProcessorCount <UInt32[]>]
[-CoresPerPhysicalProcessor <UInt32[]>]
[-LogicalProcessorsPerPhysicalProcessor <UInt32[]>]
[-OSMajor <UInt32[]>]
[-OSMinor <UInt32[]>]
[-OSBuildNumber <UInt32[]>]
[-OSPlatformId <UInt32[]>]
[-ServicePackMajor <UInt32[]>]
[-ServicePackMinor <UInt32[]>]
[-OSSuiteMask <UInt32[]>]
[-OSProductType <UInt32[]>]
[-OSSerialNumber <String[]>]
[-OSCountryCode <String[]>]
[-OSCurrentTimeZone <Int16[]>]
[-OSDaylightInEffect <Boolean[]>]
[-OSLastBootUpTime <DateTime[]>]
[-MaximumMemory <UInt64[]>]
[-SystemSMBIOSUUID <String[]>]
[-SystemSerialNumber <String[]>]
[-SystemDNSHostName <String[]>]
[-SystemDomainName <String[]>]
[-CreationTime <DateTime[]>]
[-SystemManufacturer <String[]>]
[-SystemProductName <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
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.
Examples
Example 1: Get system information
PS C:\>Get-UalSystemId
This command gets an MsftUal_SystemId object for the current system.
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 |
-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 |
-CoresPerPhysicalProcessor
Specifies an array of values. Each value specifies the number of cores for the physical processor of the system.
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 |
-CreationTime
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.
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 |
-LogicalProcessorsPerPhysicalProcessor
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.
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 |
-MaximumMemory
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.
Parameter properties
| Type: | UInt64[] |
| 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 |
-OSBuildNumber
Specifies an array of values. Each value represents the build number for the operating system.
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 |
-OSCountryCode
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.
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 |
-OSCurrentTimeZone
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.
Parameter properties
| Type: | Int16[] |
| 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 |
-OSDaylightInEffect
Specifies an array of Boolean values. If a value is $True, daylight saving time is in effect.
Parameter properties
| Type: | Boolean[] |
| 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 |
-OSLastBootUpTime
Specifies an array of DateTime objects. A value represents the last time the operating system was restarted.
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 |
-OSMajor
Specifies an array of values. Each value represents the major portion of the version number of an operating system.
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 |
-OSMinor
Specifies an array of values. Each value represents the minor portion of the version number of an operating system.
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 |
-OSPlatformId
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.
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 |
-OSProductType
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.
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 |
-OSSerialNumber
Specifies an array of strings. Each string is an operating system product serial number.
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 |
-OSSuiteMask
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.
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 |
-PhysicalProcessorCount
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.
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 |
-ServicePackMajor
Specifies an array of values. Each value represents the major portion of the version number of a service pack.
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 |
-ServicePackMinor
Specifies an array of values. Each value represents the minor portion of the version number of a service pack.
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 |
-SystemDNSHostName
Specifies an array of strings. Each string is a server name according to the Domain Name System (DNS) 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 |
-SystemDomainName
Specifies an array of strings. Each sting is the name of the domain or workgroup that the server belongs to.
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 |
-SystemManufacturer
Specifies an array of strings. Each string represents the name of the BIOS manufacturer.
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 |
-SystemProductName
Specifies an array of strings. Each string represents the product name specified in the system BIOS.
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 |
-SystemSerialNumber
Specifies an array of strings. Each string represents a unit identification for 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 |
-SystemSMBIOSUUID
Specifies an array of strings. Each string represents the universally unique identifier (UUID) for this server unit as reported by the SMBIOS.
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 |
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.