New-CimInstance

New-CimInstance
    [-ClassName] <String>
    [[-Property] <IDictionary>]
    [-Key <String[]>]
    [-Namespace <String>]
    [-OperationTimeoutSec <UInt32>]
    [-ComputerName <String[]>]
    [-ClientOnly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-CimInstance
    [-ClassName] <String>
    [[-Property] <IDictionary>]
    -CimSession <CimSession[]>
    [-Key <String[]>]
    [-Namespace <String>]
    [-OperationTimeoutSec <UInt32>]
    [-ClientOnly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-CimInstance
    [[-Property] <IDictionary>]
    -ResourceUri <Uri>
    -CimSession <CimSession[]>
    [-Key <String[]>]
    [-Namespace <String>]
    [-OperationTimeoutSec <UInt32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-CimInstance
    [[-Property] <IDictionary>]
    -ResourceUri <Uri>
    [-Key <String[]>]
    [-Namespace <String>]
    [-OperationTimeoutSec <UInt32>]
    [-ComputerName <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-CimInstance
    [-CimClass] <CimClass>
    [[-Property] <IDictionary>]
    -CimSession <CimSession[]>
    [-OperationTimeoutSec <UInt32>]
    [-ClientOnly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

New-CimInstance
    [-CimClass] <CimClass>
    [[-Property] <IDictionary>]
    [-OperationTimeoutSec <UInt32>]
    [-ComputerName <String[]>]
    [-ClientOnly]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

This cmdlet is only available on the Windows platform.

The New-CimInstance cmdlet creates an instance of a CIM class based on the class definition on either the local computer or a remote computer. By default, the New-CimInstance cmdlet creates an instance on the local computer.

This example creates an instance of a CIM Class named Win32_Environment in the root/CIMV2 namespace on the computer.

$prop = @{
    Name = "testvar"
    VariableValue = "testvalue"
    UserName = "___domain\user"
}
New-CimInstance -ClassName Win32_Environment -Property $prop

No client side validation is performed if the class does not exist, the properties are wrong, or if the server rejects the call. If the instance is created successfully, the cmdlet outputs the newly created instance.

This example retrieves a CIM class object and stores it in a variable named $class. The contents of the variable are then passed to the New-CimInstance cmdlet.

$class = Get-CimClass -ClassName Win32_Environment
$prop = @{
    Name = "testvar"
    VariableValue = "testvalue"
    UserName = "Contoso\User1"
}
New-CimInstance -CimClass $class -Property $prop

This example creates a dynamic instance of a CIM class named Win32_Process on the client computer without getting the instance from the server. The new instance is stored in the variable $a. This dynamic instance can be used to perform operations if the instance with this key exists on the server.

$instance = @{
    ClassName = 'Win32_Process'
    Property = @{
        Handle = 0
    }
    Key = 'Handle'
    ClientOnly = $true
}
$a = New-CimInstance @instance

Get-CimInstance -CimInstance $a
Invoke-CimMethod -CimInstance $a -MethodName GetOwner

ProcessId Name                HandleCount WorkingSetSize VirtualSize
--------- ----                ----------- -------------- -----------
0         System Idle Process 0           8192           8192

Domain         :
ReturnValue    : 2
User           :
PSComputerName :

The Get-CimInstance cmdlet then retrieves a particular single instance. The Invoke-CimMethod cmdlet calls the GetOwner method on the retrieved instance.

This example gets an instance of a CIM class named MSFT_Something in the namespace root/somewhere and stores it in a variable named $class. The variable is passed to the New-CimInstance cmdlet to create a new CIM instance and perform client side validations on the new instance.

$class = Get-CimClass -ClassName MSFT_Something -Namespace root/somewhere
New-CimInstance -CimClass $class -Property @{"Prop1"=1;"Prop2"="value"} -ClientOnly

In this example, using the CimClass parameter instead of the ClassName parameter validates that Prop1 and Prop2 actually exist and that the keys are marked correctly.

You cannot use the ComputerName or CimSession parameter with the ClientOnly parameter.

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.

You can't pipe objects to this cmdlet.

This cmdlet returns an object that contains the CIM instance information.

PowerShell includes the following aliases for New-CimInstance:

• Windows:
  • ncim

This cmdlet is only available on Windows platforms.