Updating VPN services

PUT /v2.0/vpn/vpnservices/{service_id}

Update the attributes of a VPN service.

You cannot update a service with a PENDING_* status.

Source: https://docs.openstack.org/api-ref/network/v2/index.html?expanded=update-vpn-service-detail#update-vpn-service

Request

Name In Type Description
service_id path string The ID of the VPN service.
vpnservice body object A vpnservice object.
name (Optional) body string A human-readable name of the resource. Default is an empty string.
description (Optional) body string A human-readable description for the resource. Default is an empty string.
admin_state_up body boolean The administrative state of the resource, which is up (true) or down (false).

Example

# curl -ks -X PUT -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' -d '\
{
    "vpnservice": {
        "description": "VPN service"
    }
}' https://<node_IP_addr>:9696/v2.0/vpn/vpnservices/d6116b75-db78-4d07-9911-226b4655838a

Response

Parameters

Name In Type Description
vpnservice body object A vpnservice object.
router_id path string The ID of the router.
status body string Indicates whether the IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
name (Optional) body string A human-readable name of the resource. Default is an empty string.
description (Optional) body string A human-readable description for the resource. Default is an empty string.
external_v4_ip body string The read-only external (public) IPv4 address that is used for the VPN service. The VPN plugin sets this address if an IPv4 interface is available.
external_v6_ip body string The read-only external (public) IPv6 address that is used for the VPN service. The VPN plugin sets this address if an IPv6 interface is available.
admin_state_up body boolean The administrative state of the resource, which is up (true) or down (false).
subnet_id (Optional) body string If you specify only a subnet UUID, the networking service allocates an available IP from that subnet to the port. If you specify both a subnet UUID and an IP address, the networking service tries to allocate the address to the port.
tenant_id body string The ID of the project.
project_id body string The ID of the project.
flavor_id body string The ID of the flavor.
id body string The ID of the VPN service.

Status codes

Success

Code Reason
200 - OK Request was successful.

Error

Code Reason
400 - Bad Request

Some content in the request was invalid.

401 - Unauthorized

User must authenticate before making a request.

404 - Not Found

The requested resource could not be found.

Example

{
  "vpnservice": {
    "id": "d6116b75-db78-4d07-9911-226b4655838a",
    "name": "vpnservice",
    "description": "VPN service",
    "tenant_id": "284a2547ea8445d1be0e68ef2d76672c",
    "subnet_id": null,
    "router_id": "923f2578-079e-40f1-b0a9-23c2b48dbdcd",
    "flavor_id": null,
    "admin_state_up": true,
    "external_v4_ip": "10.136.18.148",
    "external_v6_ip": null,
    "status": "ACTIVE",
    "project_id": "284a2547ea8445d1be0e68ef2d76672c"
  }
}