NSX-T Data Center REST API

Edit IPSec VPN service (Deprecated)

Edit IPSec VPN service for given logical router. Deprecated:
Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>
PUT /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>

Request:

Method:

PUT

URI Path(s):

/api/v1/vpn/ipsec/services/<ipsec-vpn-service-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IPSecVPNService+

IPSecVPNService (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bypass_rules	Bypass Policy rules Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session.	array of IPSecVPNPolicyRule
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable virtual private network (VPN) service If true, enable VPN services for given logical router.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_log_level	Internet key exchange (IKE) log level Log level for internet key exchange (IKE).	string	Enum: DEBUG, INFO, WARN, ERROR, EMERGENCY Default: "INFO"
ipsec_ha_sync	IPSec HA State Sync flag Enable/disable IPSec HA state sync. IPSec HA state sync can be disabled in case there are performance issues with the state sync messages. Default is to enable HA Sync.	boolean	Default: "True"
logical_router_id	Logical router id Logical router id.	string	Required
resource_type	Must be set to the value IPSecVPNService	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/vpn/ipsec/services/f770a847-a6c9-4bc0-94cb-1dd1d5ae622a { "resource_type" : "IPSecVPNService", "description" : "Manage VPN serviceplr1", "id" : "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a", "display_name" : "IPSec VPN serviceplr1", "logical_router_id" : "518cc148-75ce-4973-9a79-07da0b8b2147", "ike_log_level" : "ERROR", "enabled" : true, "_create_time" : 1517293097281, "_last_modified_user" : "admin", "_last_modified_time" : 1517293097281, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNService+

IPSecVPNService (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
bypass_rules	Bypass Policy rules Bypass policy rules are configured using VPN service. Bypass rules always have higher priority over protect rules and they affect all policy based vpn sessions associated with the IPSec VPN service. Protect rules are defined per policy based vpn session.	array of IPSecVPNPolicyRule
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enable virtual private network (VPN) service If true, enable VPN services for given logical router.	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
ike_log_level	Internet key exchange (IKE) log level Log level for internet key exchange (IKE).	string	Enum: DEBUG, INFO, WARN, ERROR, EMERGENCY Default: "INFO"
ipsec_ha_sync	IPSec HA State Sync flag Enable/disable IPSec HA state sync. IPSec HA state sync can be disabled in case there are performance issues with the state sync messages. Default is to enable HA Sync.	boolean	Default: "True"
logical_router_id	Logical router id Logical router id.	string	Required
resource_type	Must be set to the value IPSecVPNService	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "IPSecVPNService", "description" : "Manage VPN serviceplr1", "id" : "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a", "display_name" : "IPSec VPN serviceplr1", "logical_router_id" : "518cc148-75ce-4973-9a79-07da0b8b2147", "ike_log_level" : "ERROR", "enabled" : true, "_create_time" : 1517293097281, "_last_modified_user" : "admin", "_last_modified_time" : 1517293097281, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 1 }

Required Permissions:

crud

Feature:

vpn

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable