Use-Config

NAME Use-Config



SYNOPSIS

Applies a saved configuration





SYNTAX

Use-Config [-Name] <String> [[-Parameter] <Hashtable>] [-ComputerName <String>] [-Credential <PSCredential>]

[-CertificatePath <String>] [-AzureVirtualMachine <String[]>] [<CommonParameters>]





DESCRIPTION

Applies a saved DSC configuration to the local machine, a remote machine, or an azure virtual machine





PARAMETERS

-Name <String>

The name of the configuration



Required? true

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Parameter <Hashtable>

The parameters to the configuration



Required? false

Position? 2

Default value @{}

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ComputerName <String>

The name of a computer within your network



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

The credential used to run the DSC configuration



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificatePath <String>

The path to a DSC certificate



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AzureVirtualMachine <String[]>

The name of an Azure Virtual Machine. Using this requires that you have the Azure PowerShell module installed.

|Options $aModule = Import-Module Azure -Global -Passthru -ErrorAction SilentlyContinue; if ($aModule) {

Get-AzureVM | Select-Object -ExpandProperty Name }

|Multisele



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

System.Management.Automation.PSObject





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Use-Config MySavedConfig













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Use-Config MySavedConfig -AzureVirtualMachine myAzureVM















RELATED LINKS

Save-Config

Get-Config