Set-CMVpnProfileConfigurationItem
Modifies a VPN profile.
Syntax
Set-CMVpnProfileConfigurationItem
[-Description <String>]
[-Digest <ConfigurationItem>]
[-DigestPath <String>]
[-DigestXml <String>]
[-Name] <String>
[-NewName <String>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMVpnProfileConfigurationItem
[-InputObject] <IResultObject>
[-Description <String>]
[-Digest <ConfigurationItem>]
[-DigestPath <String>]
[-DigestXml <String>]
[-NewName <String>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMVpnProfileConfigurationItem
[-Description <String>]
[-Digest <ConfigurationItem>]
[-DigestPath <String>]
[-DigestXml <String>]
[-Id] <Int32>
[-NewName <String>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-CMVpnProfileConfigurationItem cmdlet modifies a virtual private network (VPN) profile. Client computers use VPN profiles to remotely connect to a company network over the Internet.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
Examples
Example 1: Modify a VPN profile configuration item
PS XYZ:\> Set-CMVpnProfileConfigurationItem -ID "AAA0004D" -DesiredConfigurationDigestPath "C:\Digests\Vpn2.xml"
This command modifies the VPN profile configuration item with the ID AAA0004D. In this case, the digest path is changed to C:\Digests\Vpn2.xml.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specifies the description of the VPN profile that this cmdlet modifies.
Type: | String |
Aliases: | LocalizedDescription |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Digest
Type: | ConfigurationItem |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DigestPath
Type: | String |
Aliases: | DesiredConfigurationDigestPath |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DigestXml
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
Specifies an array of IDs of VPN profile objects.
Type: | Int32 |
Aliases: | CIId, CI_ID |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies a VPN profile object. To obtain a VPN profile object, use the Get-CMVpnProfileConfigurationItem cmdlet.
Type: | IResultObject |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies an array of names of VPN profiles.
Type: | String |
Aliases: | LocalizedDisplayName |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NewName
Specifies the new name of the VPN profile that this cmdlet sets.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Microsoft.ConfigurationManagement.DesiredConfigurationManagement.ConfigurationItem
Outputs
System.Object