​
Select Service
ves-io-schema-tunnel-API-Create
Published April 5, 2023 | Last modified March 20, 2025
Examples of creating tunnel
Usecase:
Create tunnel-1
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "tunnel-1",
"namespace": "system"
},
"spec": {
"local_ip": {
"intf": {
"local_intf": [
{
"tenant": "acmecorp",
"namespace": "system",
"name": "network-interface-1"
}
]
}
},
"remote_ip": {
"endpoints": {
"endpoints": {
"master-0/node-1": {
"ip": {
"ipv4": {
"addr": "1.1.1.1"
}
}
},
"node-2": {
"ip": {
"ipv4": {
"addr": "1.1.1.2"
}
}
}
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"url": "string://\u003cbase64\u003e"
}
}
}
}
}
}
Copied!
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "tunnel-1",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "4f6bd962-3eae-48b6-ac87-d105330dff26",
"creation_timestamp": "2025-03-11T00:57:12.662523Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"intf": {
"local_intf": [
{
"kind": "network_interface.Object",
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"tenant": "acmecorp",
"namespace": "system",
"name": "network-interface-1"
}
]
}
},
"remote_ip": {
"endpoints": {
"endpoints": {
"master-0/node-1": {
"ip": {
"ipv4": {
"addr": "1.1.1.1"
}
}
},
"node-2": {
"ip": {
"ipv4": {
"addr": "1.1.1.2"
}
}
}
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-1","namespace":"system"},"spec":{"local_ip":{"intf":{"local_intf":[{"tenant":"acmecorp","namespace":"system","name":"network-interface-1"}]}},"remote_ip":{"endpoints":{"endpoints":{"master-0/node-1":{"ip":{"ipv4":{"addr":"1.1.1.1"}}},"node-2":{"ip":{"ipv4":{"addr":"1.1.1.2"}}}}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'
Copied!
curl response:
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:12 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "tunnel-1",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "4f6bd962-3eae-48b6-ac87-d105330dff26",
"creation_timestamp": "2025-03-11T00:57:12.662523Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"intf": {
"local_intf": [
{
"kind": "network_interface.Object",
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"tenant": "acmecorp",
"namespace": "system",
"name": "network-interface-1"
}
]
}
},
"remote_ip": {
"endpoints": {
"endpoints": {
"master-0/node-1": {
"ip": {
"ipv4": {
"addr": "1.1.1.1"
}
}
},
"node-2": {
"ip": {
"ipv4": {
"addr": "1.1.1.2"
}
}
}
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Usecase:
Create tunnel-2
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "tunnel-2",
"namespace": "system"
},
"spec": {
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"site_local": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"url": "string://\u003cbase64\u003e"
}
}
}
}
}
}
Copied!
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "tunnel-2",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "69a4bddf-23f2-4605-bbd1-4d582c0efc50",
"creation_timestamp": "2025-03-11T00:57:12.669027Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"site_local": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-2","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'
Copied!
curl response:
HTTP/1.1 200 OK
Content-Length: 1288
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:12 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "tunnel-2",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "69a4bddf-23f2-4605-bbd1-4d582c0efc50",
"creation_timestamp": "2025-03-11T00:57:12.669027Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"site_local": {
}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Usecase:
Create tunnel-3
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "tunnel-3",
"namespace": "system"
},
"spec": {
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"site_local_inside": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"url": "string://\u003cbase64\u003e"
}
}
}
}
}
}
Copied!
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "tunnel-3",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "cd0d085c-19db-4726-8891-d132e122a160",
"creation_timestamp": "2025-03-11T00:57:12.677390Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"site_local_inside": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-3","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local_inside":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'
Copied!
curl response:
HTTP/1.1 200 OK
Content-Length: 1295
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:12 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "tunnel-3",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "cd0d085c-19db-4726-8891-d132e122a160",
"creation_timestamp": "2025-03-11T00:57:12.677390Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"site_local_inside": {
}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Usecase:
Create tunnel-4
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "tunnel-4",
"namespace": "system"
},
"spec": {
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"public": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"url": "string://\u003cbase64\u003e"
}
}
}
}
}
}
Copied!
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "tunnel-4",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "20a9fc52-9e53-4760-a1eb-9effb91c1894",
"creation_timestamp": "2025-03-11T00:57:12.683626Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"public": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-4","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"public":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'
Copied!
curl response:
HTTP/1.1 200 OK
Content-Length: 1284
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:12 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "tunnel-4",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "20a9fc52-9e53-4760-a1eb-9effb91c1894",
"creation_timestamp": "2025-03-11T00:57:12.683626Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"ip_address": {
"ipv4": {
"addr": "192.168.0.10"
}
},
"virtual_network_type": {
"public": {
}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Usecase:
Create tunnel-5
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "tunnel-5",
"namespace": "system"
},
"spec": {
"local_ip": {
"ip_address": {
"auto": {},
"virtual_network_type": {
"site_local": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"url": "string://\u003cbase64\u003e"
}
}
}
}
}
}
Copied!
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "tunnel-5",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "ea20b0c8-e371-4e51-9799-dfdc9b9fbbaa",
"creation_timestamp": "2025-03-11T00:57:12.697658Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"auto": {},
"virtual_network_type": {
"site_local": {}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-5","namespace":"system"},"spec":{"local_ip":{"ip_address":{"auto":{},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'
Copied!
curl response:
HTTP/1.1 200 OK
Content-Length: 1216
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:12 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "tunnel-5",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "ea20b0c8-e371-4e51-9799-dfdc9b9fbbaa",
"creation_timestamp": "2025-03-11T00:57:12.697658Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"tunnel_type": "IPSEC_PSK",
"local_ip": {
"ip_address": {
"auto": {
},
"virtual_network_type": {
"site_local": {
}
}
}
},
"remote_ip": {
"ip": {
"ipv4": {
"addr": "192.168.0.10"
}
}
},
"params": {
"ipsec": {
"ipsec_psk": {
"clear_secret_info": {
"provider": "",
"url": "string://\u003cbase64\u003e"
},
"blindfold_secret_info_internal": null,
"secret_encoding_type": "EncodingNone"
}
}
}
}
}
Copied!