Get-CimClass
Get-CimClass
Gets a list of CIM classes in a specific namespace.
Syntax
Parameter Set: ComputerSet
Get-CimClass [[-ClassName] <String> ] [[-Namespace] <String> ] [-ComputerName <String[]> ] [-MethodName <String> ] [-OperationTimeoutSec <UInt32> ] [-PropertyName <String> ] [-QualifierName <String> ] [ <CommonParameters>]
Parameter Set: SessionSet
Get-CimClass [[-ClassName] <String> ] [[-Namespace] <String> ] -CimSession <CimSession[]> [-MethodName <String> ] [-OperationTimeoutSec <UInt32> ] [-PropertyName <String> ] [-QualifierName <String> ] [ <CommonParameters>]
Detailed Description
The Get-CimClass cmdlet retrieves a list of CIM classes in a specific namespace.
If there is no class name supplied, then the cmdlet returns all the classes in the namespace.
Unlike a CIM instance, CIM classes do not contain the CIM session or computer name from which they are retrieved.
Parameters
-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? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-ClassName<String>
Specifies the name of the CIM class for which to perform the operation.
NOTE: You can use tab completion to browse the list of classes, because Windows PowerShell gets a list of classes from the local WMI server to provide a list of class names.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies the computer on which you want to run the CIM operation. You can specify a fully qualified domain name (FQDN) a NetBIOS name, or an IP address.
If you specify this parameter, the cmdlet creates a temporary session to the specified computer using the WsMan protocol.
If you do not specify this parameter, the cmdlet performs the operation on the local computer using Component Object Model (COM).
If multiple operations are being performed on the same computer, using a CIM session gives better performance.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-MethodName<String>
Finds the classes that have a method matching this name.
You can use wildcard characters with this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Namespace<String>
Specifies the namespace for CIM operation.
The default namespace is root/cimv2.
NOTE: You can use tab completion to browse the list of namespaces, because Windows PowerShell gets a list of namespaces from the local WMI server to provide the list of namespaces.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperationTimeoutSec<UInt32>
Specifies the amount of time that the cmdlet waits for a response from the computer.
By default, the value of this parameter is 0, which means that the cmdlet uses the default timeout value for the server.
If the OperationTimeoutSec parameter is set to a value less than the robust connection retry timeout of 3 minutes, network failures that last more than the value of the OperationTimeoutSec parameter are not recoverable, because the operation on the server times out before the client can reconnect.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PropertyName<String>
Finds the classes which have a property matching this name.
You can use wildcard characters with this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-QualifierName<String>
Filters the classes by class level qualifier name. You can use wildcard characters with this parameter.
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.
None
This cmdlet accepts no input objects.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimClass
This cmdlet returns a CIM class object.
Examples
Example 1: Get all the class definitions
This command gets all the class definitions under the namespace root/cimv2.
PS C:\> Get-CimClass
Example 2: Get the classes with a specific name
This command gets the classes that contain the word disk in their names.
PS C:\> Get-CimClass -ClassName *disk*
Example 3: Get the classes with a specific method name
This command gets the classes that start with the name Win32 and have a method name that starts with Term.
PS C:\> Get-CimClass –ClassName Win32* -MethodName Term*
Example 4: Get the classes with a specific property name
This command gets the classes that start with the name Win32 and have a property named Handle.
PS C:\> Get-CimClass –ClassName Win32* -PropertyName Handle
Example 5: Get the classes with a specific qualifier name
This command gets the classes that start with the name Win32, contain the word Disk in their names and have the specified qualifier Association.
PS C:\> Get-CimClass –ClassName Win32*Disk* -QualifierName Association
Example 6: Get the class definitions from a specific namespace
This command gets the class definitions that contain the word Net in their names from the specified namespace root/standardCimv2.
PS C:\> Get-CimClass -Namespace root/standardCimv2 -ClassName *Net*
Example 7: Get the class definitions from a remote server
This command gets the class definitions that contain the word disk in their names from the specified remote servers Server01 and Server02.
PS C:\> Get-CimClass -ClassName *disk* -ComputerName Server01, Server02
Example 8: Get the classes by using a CIM session
This set of commands creates a session with multiple computers and stores it into a variable $s using the New-CimSession cmdlet, and then gets the classes using the Get-CimClass cmdlet.
PS C:\> $s = New-CimSession -ComputerName Server01, Server02
PS C:\> Get-CimClass -ClassName *disk* -CimSession $s