image/svg+xml image/svg+xml Layer 1 Layer 2 background powershell.one
  • Feb 29, 2020

Win32_PortResource

The Win32_PortResource WMI class represents an I/O port on a computer system running Windows.

The Win32_PortResource WMI class represents an I/O port on a computer system running Windows.

Methods

Win32_PortResource has no methods.

Properties

Win32_PortResource returns 11 properties:

'Alias','Caption','CreationClassName','CSCreationClassName','CSName','Description',
'EndingAddress','InstallDate','Name','StartingAddress','Status'

Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:

Get-CimInstance -ClassName Win32_PortResource -Property *

Most WMI classes return one or more instances.

When Get-CimInstance returns no result, then apparently no instances of class Win32_PortResource exist. This is normal behavior.

Either the class is not implemented on your system (may be deprecated or due to missing drivers, i.e. CIM_VideoControllerResolution), or there are simply no physical representations of this class currently available (i.e. Win32_TapeDrive).

Alias

BOOLEAN

If TRUE, this instance represents one of the ranges with an alias. If FALSE, the instance represents a base port address. A base port address is a predetermined port address dedicated to a specific service or device. A port alias address is one that a device responds to as if it were the actual address of an I/O port.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, Alias

Caption

STRING MAX 64 CHAR

Short description of the object.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, Caption

CreationClassName

STRING MAX 256 CHAR

Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, the property allows all instances of this class and its subclasses to be uniquely identified.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, CreationClassName

CSCreationClassName

STRING MAX 256 CHAR

Creation class name of the scoping computer system.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, CSCreationClassName

CSName

STRING MAX 256 CHAR

Name of the scoping computer system.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, CSName

Description

STRING

Description of the object.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, Description

EndingAddress

UINT64

Ending address of memory mapped I/O.

For more information about using uint64 values in scripts, see Scripting in WMI.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, EndingAddress

InstallDate

DATETIME

Date and time the object was installed. This property does not need a value to indicate that the object is installed.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, InstallDate

Name

STRING

Label by which the object is known. When subclassed, the property can be overridden to be a key property.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, Name

StartingAddress

KEY PROPERTY UINT64

Starting address of memory mapped I/O. The hardware resource identifier property should be set to this value to construct the mapped I/O resource key.

For more information about using uint64 values in scripts, see Scripting in WMI.

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress

Status

STRING MAX 10 CHAR

Current status of an object. Various operational and nonoperational statuses can be defined. Available values:

$values = 'Degraded','Error','Lost Comm','No Contact','NonRecover','OK','Pred Fail','Service','Starting','Stopping','Stressed','Unknown'

Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property StartingAddress, Status

Examples

List all instances of Win32_PortResource 
Get-CimInstance -ClassName Win32_PortResource

Learn more about Get-CimInstance and the deprecated Get-WmiObject.

View all properties 
Get-CimInstance -ClassName Win32_PortResource -Property *
View key properties only 
Get-CimInstance -ClassName Win32_PortResource -KeyOnly

Selecting Properties

To select only some properties, pipe the results to Select-Object -Property a,b,c with a comma-separated list of the properties you require. Wildcards are permitted.

Get-CimInstance always returns all properties but only retrieves the ones that you specify. All other properties are empty but still present. That’s why you need to pipe the results into Select-Object if you want to limit the visible properties, i.e. for reporting.

Selecting Properties

The code below lists all available properties. Remove the ones you do not need:

$properties = 'Alias',
              'Caption',
              'CreationClassName',
              'CSCreationClassName',
              'CSName',
              'Description',
              'EndingAddress',
              'InstallDate',
              'Name',
              'StartingAddress',
              'Status'
Get-CimInstance -ClassName Win32_PortResource | Select-Object -Property $properties
Limiting Network Bandwidth

If you work remotely, it makes sense to limit network bandwidth by filtering the properties on the server side, too:

Get-CimInstance -Class Win32_PortResource -Property $property | 
Select-Object -Property $property

Selecting Instances

To select some instances, use Get-CimInstance and a WMI Query. The wildcard character in WMI Queries is % (and not “*”).

The parameter -Filter runs a simple query.

Listing all instances where the property Caption starts with “A” 
Get-CimInstance -Class Win32_PortResource -Filter 'Caption LIKE "a%"'
Using a WQL Query

The parameter -Query uses a query similar to SQL and combines the parameters -Filter and -Property. This returns all instances where the property Caption starts with “A”, and returns the properties specified:

Get-CimInstance -Query "SELECT EndingAddress, Name, Caption, InstallDate FROM Win32_PortResource WHERE Caption LIKE 'a%'"

Any property you did not specify is still present but empty. You might need to use Select-Object to remove all unwanted properties:

Get-CimInstance -Query "SELECT EndingAddress, Name, Caption, InstallDate FROM Win32_PortResource WHERE Caption LIKE 'a%'" | Select-Object -Property EndingAddress, Name, Caption, InstallDate

Accessing Remote Computers

To access remote systems, you need to have proper permissions. User the parameter -ComputerName to access one or more remote systems.

Authenticating as Current User 
# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with your current identity:
$result = Get-CimInstance -ClassName Win32_PortResource -ComputerName $list 
$result
Authenticating as Different User

Use a CIMSession object to authenticate with a new identity:

# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with a different identity:
$cred = Get-Credential -Message 'Authenticate to retrieve WMI information:'
$session = New-CimSession -ComputerName $list -Credential $cred

$result = Get-CimInstance Win32_PortResource -CimSession $session

# remove the session after use (if you do not plan to re-use it later)
Remove-CimSession -CimSession $session

$result

Learn more about accessing remote computers.

Requirements

To use Win32_PortResource, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_PortResource was introduced on clients with Windows Vista and on servers with Windows Server 2008.

Namespace

Win32_PortResource lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_PortResource is implemented in CIMWin32.dll and defined in CIMWin32.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\CIMWin32.mof
© powershell.one 2020 - Legal - Contact Us