VPNConnection

System Center
 

Updated: June 27, 2017

Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview

Creates, reads, updates, and deletes virtual private network (VPN) connections associated with virtual machines.

GETPOSTPUTDELETE
YesYesYesYes

GET

Gets the specified VPN connections.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
IDEdm.GuidYesThe identifier of the VPN connection.
VMMNetworkGatewayIDEdm.GuidYesSpecifies a VM network gateway object.

POST

Creates a new VPN connection.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
IDEdm.GuidYesThe identifier of the VPN connection.
NameEdm.StringYesThe name of the VMM object.
VMMNetworkGatewayIDEdm.GuidYesA VM network gateway object.

PUT

Updates a VPN connection.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
IDEdm.GuidYesThe identifier of the VPN connection.
AuthenticationMethodEdm.StringNoSpecifies the numerical identifier (as a globally unique identifier, or GUID) for a specific object.
DescriptionEdm.StringNoStates a description for the specified object.
NameEdm.StringNoSpecifies the name of the VMM object.
RunAsAccountIdEdm.GuidNoSpecifies the ID of a Run As account.
TargetIPv4VPNAddressEdm.StringNoSpecifies a target virtual private network (VPN) address in IPv4 format.
TargetIPv6VPNAddressEdm.StringNoSpecifies a target virtual private network (VPN) address in IPv6 format.
VMMNetworkGatewayIDEdm.GuidYesSpecifies a VM network gateway object.

DELETE

Deletes a VPN connection.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp that restricts the query.
IDEdm.GuidYesThe identifier of the VPN connection.
NameEdm.StringYesThe name of the VMM object.
VMMNetworkGatewayIDEdm.GuidYesSpecifies a VM network gateway object.

VMM Collections Reference R2

Show: