Skip to content

Latest commit

 

History

History
138 lines (106 loc) · 2.7 KB

Invoke-PsDscResource.md

File metadata and controls

138 lines (106 loc) · 2.7 KB
external help file GeneratedBy Module Name online version schema
PSDSC-help.xml
Sampler update_help_source task
PSDSC
2.0.0

Invoke-PsDscResource

SYNOPSIS

Invoke DSC version 3 resource using the command-line utility

SYNTAX

Invoke-PsDscResource [-ResourceName] <String> [[-Operation] <String>] [[-ResourceInput] <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The function Invoke-PsDscResource invokes Desired State Configuration version 3 resources calling the executable.

EXAMPLES

EXAMPLE 1

Invoke-PsDscResource -ResourceName Microsoft.Windows/RebootPending -Operation Get

Execute Microsoft.Windows/RebootPending resource on Windows system to check if there is a pending reboot

PARAMETERS

-ResourceName

The resource name to execute.

Type: String
Parameter Sets: (All)
Aliases: Name

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Operation

The operation capability to execute e.g. 'Set'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceInput

The resource input to provide. Supports JSON, YAML path and PowerShell hash table.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

For more details, go to module repository at: https://github.com/Gijsreyn/PSDSC.

RELATED LINKS