Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions reference/5.1/CimCmdlets/Register-CimIndicationEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ Register-CimIndicationEvent [-Namespace <String>] [-ClassName] <String>
### QueryExpressionSessionSet

```
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String> [-QueryDialect <String>]
[-OperationTimeoutSec <UInt32>] -CimSession <CimSession> [[-SourceIdentifier] <String>]
[[-Action] <ScriptBlock>] [-MessageData <PSObject>] [-SupportEvent] [-Forward]
[-MaxTriggerCount <Int32>] [<CommonParameters>]
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String>
[-QueryDialect <String>] [-OperationTimeoutSec <UInt32>] -CimSession <CimSession>
[[-SourceIdentifier] <String>] [[-Action] <ScriptBlock>] [-MessageData <PSObject>]
[-SupportEvent] [-Forward] [-MaxTriggerCount <Int32>] [<CommonParameters>]
```

### QueryExpressionComputerSet

```
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String> [-QueryDialect <String>]
[-OperationTimeoutSec <UInt32>] [-ComputerName <String>] [[-SourceIdentifier] <String>]
[[-Action] <ScriptBlock>] [-MessageData <PSObject>] [-SupportEvent] [-Forward]
[-MaxTriggerCount <Int32>] [<CommonParameters>]
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String>
[-QueryDialect <String>] [-OperationTimeoutSec <UInt32>] [-ComputerName <String>]
[[-SourceIdentifier] <String>] [[-Action] <ScriptBlock>] [-MessageData <PSObject>]
[-SupportEvent] [-Forward] [-MaxTriggerCount <Int32>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -67,7 +67,11 @@ This example subscribes to the events generated by the class named **Win32_Proce
class raises an event whenever a process starts.

```powershell
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted"
$event = @{
ClassName = 'Win32_ProcessStartTrace'
SourceIdentifier = 'ProcessStarted'
}
Register-CimIndicationEvent @event
Get-Event -SourceIdentifier "ProcessStarted"
```

Expand Down Expand Up @@ -98,7 +102,12 @@ $action = {
$id = $event.SourceEventArgs.NewEvent.ProcessId
Write-Host -Object "New Process Started : Name = $name ID = $id"
}
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -Action $action
$event = @{
ClassName = 'Win32_ProcessStartTrace'
SourceIdentifier = 'ProcessStarted'
Action = $action
}
Register-CimIndicationEvent @event
```

For more information, see
Expand All @@ -111,7 +120,12 @@ CIM server are stored in the event queue in the current PowerShell session and t
`Get-Event` to retrieve the events.

```powershell
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -ComputerName Server01
$event = @{
ClassName = 'Win32_ProcessStartTrace'
SourceIdentifier = 'ProcessStarted'
ComputerName = 'Server01'
}
Register-CimIndicationEvent @event
Get-Event -SourceIdentifier "ProcessStarted"
```

Expand All @@ -126,7 +140,7 @@ event is raised, instead of sending the event to the event queue. Enclose the co
The script block specified with **Action** can include the `$Event`, `$EventSubscriber`, `$Sender`,
`$SourceEventArgs`, and `$SourceArgs` automatic variables, which provide information about the event
to the **Action** script block. For more information, see
[About Automatic Variables](../microsoft.powershell.core/about/about_automatic_variables.md).
[About Automatic Variables](../Microsoft.PowerShell.Core/About/about_Automatic_Variables.md).

```yaml
Type: System.Management.Automation.ScriptBlock
Expand Down Expand Up @@ -401,4 +415,3 @@ This cmdlet returns an **EventSubscription** object.
[Get-CimSession](Get-CimSession.md)

[New-CimSession](New-CimSession.md)

18 changes: 10 additions & 8 deletions reference/5.1/CimCmdlets/Remove-CimInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,33 @@ Removes a CIM instance from a computer.
### CimInstanceComputerSet (Default)

```
Remove-CimInstance [-ResourceUri <Uri>] [-ComputerName <String[]>] [-OperationTimeoutSec <UInt32>]
[-InputObject] <CimInstance> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-CimInstance [-ResourceUri <Uri>] [-ComputerName <String[]>]
[-OperationTimeoutSec <UInt32>] [-InputObject] <CimInstance> [-WhatIf] [-Confirm]
[<CommonParameters>]
```

### CimInstanceSessionSet

```
Remove-CimInstance -CimSession <CimSession[]> [-ResourceUri <Uri>] [-OperationTimeoutSec <UInt32>]
[-InputObject] <CimInstance> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-CimInstance -CimSession <CimSession[]> [-ResourceUri <Uri>]
[-OperationTimeoutSec <UInt32>] [-InputObject] <CimInstance> [-WhatIf] [-Confirm]
[<CommonParameters>]
```

### QuerySessionSet

```
Remove-CimInstance -CimSession <CimSession[]> [[-Namespace] <String>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### QueryComputerSet

```
Remove-CimInstance [-ComputerName <String[]>] [[-Namespace] <String>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down
59 changes: 41 additions & 18 deletions reference/5.1/CimCmdlets/Set-CimInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,33 @@ Modifies a CIM instance on a CIM server by calling the ModifyInstance method of
### CimInstanceComputerSet (Default)

```
Set-CimInstance [-ComputerName <String[]>] [-ResourceUri <Uri>] [-OperationTimeoutSec <UInt32>]
[-InputObject] <CimInstance> [-Property <IDictionary>] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-CimInstance [-ComputerName <String[]>] [-ResourceUri <Uri>]
[-OperationTimeoutSec <UInt32>] [-InputObject] <CimInstance> [-Property <IDictionary>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### CimInstanceSessionSet

```
Set-CimInstance -CimSession <CimSession[]> [-ResourceUri <Uri>] [-OperationTimeoutSec <UInt32>]
[-InputObject] <CimInstance> [-Property <IDictionary>] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-CimInstance -CimSession <CimSession[]> [-ResourceUri <Uri>]
[-OperationTimeoutSec <UInt32>] [-InputObject] <CimInstance> [-Property <IDictionary>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### QuerySessionSet

```
Set-CimInstance -CimSession <CimSession[]> [-Namespace <String>] [-OperationTimeoutSec <UInt32>]
[-Query] <String> [-QueryDialect <String>] -Property <IDictionary> [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-CimInstance -CimSession <CimSession[]> [-Namespace <String>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>]
-Property <IDictionary> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### QueryComputerSet

```
Set-CimInstance [-ComputerName <String[]>] [-Namespace <String>] [-OperationTimeoutSec <UInt32>]
[-Query] <String> [-QueryDialect <String>] -Property <IDictionary> [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-CimInstance [-ComputerName <String[]>] [-Namespace <String>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>]
-Property <IDictionary> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -76,7 +76,11 @@ parameter. You can modify instances matching a Windows Management Instrumentatio
(WQL) query.

```powershell
Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' -Property @{VariableValue="abcd"}
$instance = @ {
Query = 'Select * from Win32_Environment where name LIKE "testvar%"'
Property = @{VariableValue="abcd"}
}
Set-CimInstance @instance
```

### Example 2: Set the CIM instance property using pipeline
Expand Down Expand Up @@ -121,7 +125,12 @@ This example uses the common parameter **WhatIf** to specify that the modificati
done, but only output what would happen if it were done.

```powershell
Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' -Property @{VariableValue="abcd"} -WhatIf
$instance = @{
Query = 'Select * from Win32_Environment where name LIKE "testvar%"'
Property = @{VariableValue="abcd"}
WhatIf = $true
}
Set-CimInstance @instance
```

### Example 6: Set the CIM instance after confirmation from the user
Expand All @@ -130,7 +139,12 @@ This example uses the common parameter **Confirm** to specify that the modificat
only after confirmation from the user.

```powershell
Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar%"' -Property @{VariableValue="abcd"} -Confirm
$instance = @{
Query = 'Select * from Win32_Environment where name LIKE "testvar%"'
Property = @{VariableValue="abcd"}
Confirm = $true
}
Set-CimInstance @instance
```

### Example 7: Set the created CIM instance
Expand All @@ -141,7 +155,16 @@ cmdlet, and retrieves its contents in to a variable `$x`. The variable is then p
Because the **PassThru** parameter is used, This example returns a modified CIM instance object.

```powershell
$x = New-CimInstance -ClassName Win32_Environment -Property @{Name="testvar";UserName="domain\user"} -Key Name, UserName -ClientOnly
$instance = @{
ClassName = 'Win32_Environment'
Property = @{
Name="testvar"
UserName="domain\user"
}
Key = 'Name', 'UserName'
ClientOnly = $true
}
$x = New-CimInstance @instance
Set-CimInstance -CimInstance $x -Property @{VariableValue="somevalue"} -PassThru
```

Expand All @@ -154,7 +177,7 @@ of a `New-CimSession` or `Get-CimSession` cmdlet.

```yaml
Type: Microsoft.Management.Infrastructure.CimSession[]
Parameter Sets: QuerySessionSet, CimInstanceSessionSet
Parameter Sets: CimInstanceSessionSet, QuerySessionSet
Aliases:

Required: True
Expand Down Expand Up @@ -395,7 +418,7 @@ Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
-WarningAction, and -WarningVariable. For more information, see
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand Down
38 changes: 26 additions & 12 deletions reference/7.4/CimCmdlets/Register-CimIndicationEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ Register-CimIndicationEvent [-Namespace <String>] [-ClassName] <String>
### QueryExpressionSessionSet

```
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String> [-QueryDialect <String>]
[-OperationTimeoutSec <UInt32>] -CimSession <CimSession> [[-SourceIdentifier] <String>]
[[-Action] <ScriptBlock>] [-MessageData <PSObject>] [-SupportEvent] [-Forward]
[-MaxTriggerCount <Int32>] [<CommonParameters>]
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String>
[-QueryDialect <String>] [-OperationTimeoutSec <UInt32>] -CimSession <CimSession>
[[-SourceIdentifier] <String>] [[-Action] <ScriptBlock>] [-MessageData <PSObject>]
[-SupportEvent] [-Forward] [-MaxTriggerCount <Int32>] [<CommonParameters>]
```

### QueryExpressionComputerSet

```
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String> [-QueryDialect <String>]
[-OperationTimeoutSec <UInt32>] [-ComputerName <String>] [[-SourceIdentifier] <String>]
[[-Action] <ScriptBlock>] [-MessageData <PSObject>] [-SupportEvent] [-Forward]
[-MaxTriggerCount <Int32>] [<CommonParameters>]
Register-CimIndicationEvent [-Namespace <String>] [-Query] <String>
[-QueryDialect <String>] [-OperationTimeoutSec <UInt32>] [-ComputerName <String>]
[[-SourceIdentifier] <String>] [[-Action] <ScriptBlock>] [-MessageData <PSObject>]
[-SupportEvent] [-Forward] [-MaxTriggerCount <Int32>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -69,7 +69,11 @@ This example subscribes to the events generated by the class named **Win32_Proce
class raises an event whenever a process starts.

```powershell
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted"
$event = @{
ClassName = 'Win32_ProcessStartTrace'
SourceIdentifier = 'ProcessStarted'
}
Register-CimIndicationEvent @event
Get-Event -SourceIdentifier "ProcessStarted"
```

Expand Down Expand Up @@ -100,7 +104,12 @@ $action = {
$id = $event.SourceEventArgs.NewEvent.ProcessId
Write-Host -Object "New Process Started : Name = $name ID = $id"
}
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -Action $action
$event = @{
ClassName = 'Win32_ProcessStartTrace'
SourceIdentifier = 'ProcessStarted'
Action = $action
}
Register-CimIndicationEvent @event
```

For more information, see
Expand All @@ -113,7 +122,12 @@ CIM server are stored in the event queue in the current PowerShell session and t
`Get-Event` to retrieve the events.

```powershell
Register-CimIndicationEvent -ClassName 'Win32_ProcessStartTrace' -SourceIdentifier "ProcessStarted" -ComputerName Server01
$event = @{
ClassName = 'Win32_ProcessStartTrace'
SourceIdentifier = 'ProcessStarted'
ComputerName = 'Server01'
}
Register-CimIndicationEvent @event
Get-Event -SourceIdentifier "ProcessStarted"
```

Expand All @@ -128,7 +142,7 @@ event is raised, instead of sending the event to the event queue. Enclose the co
The script block specified with **Action** can include the `$Event`, `$EventSubscriber`, `$Sender`,
`$SourceEventArgs`, and `$SourceArgs` automatic variables, which provide information about the event
to the **Action** script block. For more information, see
[About Automatic Variables](../microsoft.powershell.core/about/about_automatic_variables.md).
[About Automatic Variables](../Microsoft.PowerShell.Core/About/about_Automatic_Variables.md).

```yaml
Type: System.Management.Automation.ScriptBlock
Expand Down
18 changes: 10 additions & 8 deletions reference/7.4/CimCmdlets/Remove-CimInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,33 @@ Removes a CIM instance from a computer.
### CimInstanceComputerSet (Default)

```
Remove-CimInstance [-ResourceUri <Uri>] [-ComputerName <String[]>] [-OperationTimeoutSec <UInt32>]
[-InputObject] <CimInstance> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-CimInstance [-ResourceUri <Uri>] [-ComputerName <String[]>]
[-OperationTimeoutSec <UInt32>] [-InputObject] <CimInstance> [-WhatIf] [-Confirm]
[<CommonParameters>]
```

### CimInstanceSessionSet

```
Remove-CimInstance -CimSession <CimSession[]> [-ResourceUri <Uri>] [-OperationTimeoutSec <UInt32>]
[-InputObject] <CimInstance> [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-CimInstance -CimSession <CimSession[]> [-ResourceUri <Uri>]
[-OperationTimeoutSec <UInt32>] [-InputObject] <CimInstance> [-WhatIf] [-Confirm]
[<CommonParameters>]
```

### QuerySessionSet

```
Remove-CimInstance -CimSession <CimSession[]> [[-Namespace] <String>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### QueryComputerSet

```
Remove-CimInstance [-ComputerName <String[]>] [[-Namespace] <String>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-OperationTimeoutSec <UInt32>] [-Query] <String> [-QueryDialect <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down
Loading