gtema 6b71b4a1fa Initial import of the VPN API document

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>

2022-12-07 13:22:09 +00:00

18 KiB

Raw Blame History

Updating a VPN Service

Function

This interface is used to update a VPN service.

URI

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

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
service_id	String	Yes	Specifies the VPN service ID.

Request Message

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Type	Mandatory	Description
description	String	No	Provides supplementary information about the VPN service.
name	String	No	Specifies the VPN service name.
admin_state_up	Boolean	No	Specifies the administrative status. The value can be true or false.
vpnservice	Object	Yes	Specifies the VPN service object.

The project_id parameter is not supported.
The value of name can contain 1 to 64 characters.
The value of description can contain a maximum of 255 characters.
The value of admin_state_up can only be true.
The subnet_id parameter is unconfigurable.

Response Message

Table 3 describes the response parameters.

**Table 3** Response parameters
Parameter	Type	Mandatory	Description
id	String	Yes	Specifies the VPN service ID.
router_id	String	Yes	Specifies the router ID.
status	String	Yes	Specifies the VPN service status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_UPDATE, or PENDING_DELETE.
name	String	Yes	Specifies the VPN service name.
external_v6_ip	String	Yes	Specifies the IPv6 address of the VPN service external gateway.
admin_state_up	Boolean	Yes	Specifies the administrative status. The value can be true or false.
subnet_id	String	No	Specifies the subnet ID.
tenant_id	String	Yes	Specifies the project ID.
external_v4_ip	String	Yes	Specifies the IPv4 address of the VPN service external gateway.
description	String	Yes	Provides supplementary information about the VPN service.
vpnservice	Object	Yes	Specifies the VPN service object.

Example

Example Request

PUT /v2.0/vpn/vpnservices/{service_id}
{
  "vpnservice" : {
    "description" : "Updated description"
  }
}

Example Response

{
    "vpnservice": {
        "router_id": "881b7b30-4efb-407e-a162-5630a7af3595",
        "status": "ACTIVE",
        "name": "myvpn",
        "admin_state_up": true,
        "subnet_id": null,
        "project_id": "26de9cd6cae94c8cb9f79d660d628e1f",
        "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
        "id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
        "description": "Updated description",
    }
}

Returned Values

For details, see section Common Returned Values.

Parent topic: VPN Service Management

18 KiB Raw Blame History