Copy-CMVpnProfileConfigurationItem
Copy-CMVpnProfileConfigurationItem
Renames a VPN profile.
Syntax
Parameter Set: SearchByNameMandatory
Copy-CMVpnProfileConfigurationItem -Name <String[]> -NewName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Copy-CMVpnProfileConfigurationItem -Id <String[]> -NewName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Copy-CMVpnProfileConfigurationItem -InputObject <IResultObject> -NewName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Copy-CMVpnProfileConfigurationItem cmdlet renames a virtual private network (VPN) profile.
Parameters
-Id<String[]>
Specifies an array of IDs of VPN profile objects.
Aliases |
CIId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a VPN profile object. To obtain a VPN profile object, use the Get-CMVpnProfileConfigurationItem cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names of VPN profiles.
Aliases |
LocalizedDisplayName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name to assign to the VPN profile.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Rename a VPN profile
This command renames the VPN profile named Corp_VPNNet1 to Corp_Production_VPN.
PS C:\> Copy-CMVpnProfileConfigurationItem -Name "Corp_VPNNet1" -NewName "Corp_Production_VPN"
Related topics
Get-CMVpnProfileConfigurationItem
New-CMVpnProfileConfigurationItem