api-ref: Update local_id configuration

Adding local_id configuration support to api-ref with respect to the
changes made in this commit 7cf4ef682f83fc08484011454f62c27882064dff.

Change-Id: I2ea43c8cad95cb94529a3f576dced5d306b8da4c
Closes-Bug: #1576888
This commit is contained in:
Trevor McCasland 2016-09-07 13:12:39 -05:00
parent 76ac5c1f40
commit 5f53e32f46
2 changed files with 16 additions and 0 deletions

View File

@ -1953,6 +1953,16 @@ local_ep_group_id_1:
in: body
required: true
type: string
local_id:
description: |
An ID to be used instead of the external IP address for a virtual
router used in traffic between instances on different networks in
east-west traffic. Most often, local ID would be domain name, email
address, etc. If this is not configured then the external IP address
will be used as the ID.
in: body
required: false
type: string
location:
description: |
Full URL to a service or server.

View File

@ -178,6 +178,7 @@ Request
- dpd: dpd
- timeout: timeout
- action: action
- local_id: local_id
Request Example
---------------
@ -214,6 +215,7 @@ Response Parameters
- dpd: dpd
- timeout: timeout
- action: action
- local_id: local_id
List IPSec connections
======================
@ -257,6 +259,7 @@ Response Parameters
- dpd: dpd
- timeout: timeout
- action: action
- local_id: local_id
Response Example
----------------
@ -311,6 +314,7 @@ Response Parameters
- dpd: dpd
- timeout: timeout
- action: action
- local_id: local_id
Response Example
----------------
@ -351,6 +355,7 @@ Request
- peer_id: peer_id
- name: name
- connection_id: connection_id
- local_id: local_id
Request Example
---------------
@ -387,6 +392,7 @@ Response Parameters
- dpd: dpd
- timeout: timeout
- action: action
- local_id: local_id
Response Example
----------------