jnx_routing_flexible_tunnel_service.proto
Service
FlexibleTunnel
JET RPC service providing operations to manage flexible tunnel profiles as independent objects decoupled from routes that may use them.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| FlexibleTunnelAdd | FlexibleTunnelAddRequest | FlexibleTunnelAddResponse | Flexible tunnel add operation. |
| FlexibleTunnelUpdate | FlexibleTunnelUpdateRequest | FlexibleTunnelUpdateResponse | Flexible tunnel update operation. |
| FlexibleTunnelDelete | FlexibleTunnelDeleteRequest | FlexibleTunnelDeleteResponse | Flexible tunnel Delete operation. |
| FlexibleTunnelGet | FlexibleTunnelGetRequest | FlexibleTunnelGetResponse | Flexible tunnel get operation. |
RPC(s)
The following APIs are provided by this service:
FlexibleTunnelAdd
Request to add new flexible tunnel profiles. An error will be returned if either a profile with the given name or a profile with conflicting tunnel attributes already exists. See the specific tunnel attributes for the description of conflicting attributes for that tunnel type. The request may contain from one to 1000 tunnel profiles. If the request contains multiple tunnel profiles, the profiles will be processed in the order given and the first error encountered will cause the request to abort. The API always returns the final status (success or first error encountered) and the number of profiles that were successfully updated prior to any error or full completion of the request.
Input: FlexibleTunnelAddRequest
Output: FlexibleTunnelAddResponse
FlexibleTunnelUpdate
Request to add new flexible tunnel profiles, or update the profile(s) if profiles matching the given name already exists. An error will be returned if a different profile with conflicting tunnel attributes already exists. See the specific tunnel attributes for the description of conflicting attributes for that tunnel type. The request may contain from one to 1000 tunnel profiles. If the request contains multiple tunnel profiles, the profiles will be processed in the order given and the first error encountered will cause the request to abort. The API always returns the final status (success or first error encountered) and the number of profiles that were successfully updated prior to any error or full completion of the request.
Input: FlexibleTunnelUpdateRequest
Output: FlexibleTunnelUpdateResponse
FlexibleTunnelDelete
Request to delete existing flexible tunnel profiles by name. The request may contain from one to 1000 tunnel profiles. If the request contains multiple tunnel profiles, the profiles will be processed in the order given and the first error encountered will cause the request to abort. The API always returns the final status (success or first error encountered) and the number of profiles that were successfully deleted prior to any error or full completion of the request.
Input: FlexibleTunnelDeleteRequest
Output: FlexibleTunnelDeleteResponse
FlexibleTunnelGet
Request to query the parameters of an existing flexible tunnel profile with the given name.
Input: FlexibleTunnelGetRequest
Output: FlexibleTunnelGetResponse
Message(s)
This IDL defines the following message type(s)
FlexibleTunnelAddRequest
RPC parameters for a request to add one or more flexible tunnel profiles.
| Field | Type | Description |
|---|---|---|
| tunnel_profiles | FlexibleTunnelProfile | List of one or more tunnel profiles to request addition for. |
FlexibleTunnelAddResponse
RPC return for a request to add flexible tunnel profiles.
| Field | Type | Description |
|---|---|---|
| status | RpcStatus | Top level return code. |
| sub_code | StatusCode | The API specific return sub-code for the request. |
| operations_completed | uint32 | The number of requested operations for which the operation completed successfully. |
FlexibleTunnelUpdateRequest
RPC parameters for a request to update one or more flexible tunnel profiles.
| Field | Type | Description |
|---|---|---|
| tunnel_profiles | FlexibleTunnelProfile | List of one or more tunnel profiles to request update(s) for |
FlexibleTunnelUpdateResponse
RPC return for a request to update flexible tunnel profiles.
| Field | Type | Description |
|---|---|---|
| status | RpcStatus | Top level return code. |
| sub_code | StatusCode | The API specific return sub-code for the request. |
| operations_completed | uint32 | The number of requested operations for which the operation completed successfully. |
FlexibleTunnelDeleteRequest
RPC parameters for a request to delete one or more flexible tunnel profiles.
| Field | Type | Description |
|---|---|---|
| tunnel_profile_names | string | flexible tunnel profile name to be deleted. |
FlexibleTunnelDeleteResponse
RPC return for a request to delete a flexible tunnel attribute.
| Field | Type | Description |
|---|---|---|
| status | RpcStatus | Top level return code. |
| sub_code | StatusCode | The API specific return sub-code for the request. |
| operations_completed | uint32 | The number of requested operations for which the operation completed successfully. |
FlexibleTunnelGetRequest
RPC parameters for a request to query a flexible tunnel profile.
| Field | Type | Description |
|---|---|---|
| tunnel_profile_name | string | Tunnel profile name. |
FlexibleTunnelGetResponse
RPC return for a request to query a flexible tunnel profile.
| Field | Type | Description |
|---|---|---|
| status | RpcStatus | Top level return code. |
| sub_code | StatusCode | The API specific return sub-code for the request. |
| tunnel_profile | FlexibleTunnelProfile | The profile returned. |
Enum(s)
StatusCode
Return sub_code for FlexibleTunnelDelete responses.
| Value | Description |
|---|---|
| SUCCESS | An profile was successfully deleted. |
| INTERNAL_ERROR | An internal error occurred. |
| NOT_FOUND | The specified profile does not exist. |
| TOO_MANY_OPS | Request contained too many operations. |
| INVALID_PROFILE_NAME | Invalid profile name in request. |
StatusCode
Return sub_code for FlexibleTunnelGet responses.
| Value | Description |
|---|---|
| SUCCESS | The specified profile was returned. |
| INTERNAL_ERROR | An internal error occurred. |
| NOT_FOUND | The specified profile does not exist. |
| INVALID_PROFILE_NAME | Invalid profile name in request. |
StatusCode
Response sub_code for FlexibleTunnelAdd responses.
| Value | Description |
|---|---|
| SUCCESS | A new profile was successfully added. |
| INTERNAL_ERROR | An internal error occurred. |
| ALREADY_EXISTS | The specified profile already exists. |
| TOO_MANY_OPS | Request contained too many operations. |
| INVALID_TUNNEL_PROFILE | Invalid flexible tunnel profile parameters. |
| INVALID_TUNNEL_ACTION | Invalid flexible tunnel profile action. |
| INVALID_PROFILE_NAME | Invalid profile name in request. |
StatusCode
Return sub_code for FlexibleTunnelUpdate responses.
| Value | Description |
|---|---|
| SUCCESS | A new profile was successfully added or updated. |
| INTERNAL_ERROR | An internal error occurred. |
| TOO_MANY_OPS | Request contained too many operations. |
| INVALID_TUNNEL_PROFILE | Invalid flexible tunnel profile parameters. |
| INVALID_TUNNEL_ACTION | Invalid flexible tunnel profile action. |
| INVALID_PROFILE_NAME | Invalid profile name in request. |
| ALREADY_EXISTS | A tunnel with the specified profile already exists. |
