ves-io-schema-tunnel-API-Get

Examples of getting tunnel

Usecase:

Get tunnel-1

Request using vesctl:

vesctl configuration get tunnel tunnel-1 --namespace documentation

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: tunnel-1
  namespace: documentation
object:
  metadata:
    annotations: {}
    labels: {}
    name: tunnel-1
    namespace: documentation
    uid: 10dcdf68-350b-41a4-9043-312ac4cef52c
  spec:
    gcSpec:
      localIp:
        ipAddress:
          ipAddress:
            ipv4:
              addr: 192.168.0.10
          virtualNetworkType:
            public: {}
      params:
        ipsec:
          ipsecPsk:
            clearSecretInfo:
              url: string://<base64>
      remoteIp:
        ip:
          ipv4:
            addr: 192.168.0.10
  systemMetadata:
    creationTimestamp: "2020-10-19T09:49:22.496017200Z"
    creatorClass: examplesvc
    creatorId: examplesvc
    finalizers: []
    namespace:
    - kind: namespace
      name: documentation
      tenant: acmecorp
    tenant: acmecorp
    traceInfo: 6d4a58f82607d83c:6d4a58f82607d83c:0:1
    uid: 10dcdf68-350b-41a4-9043-312ac4cef52c
resourceVersion: "754"
spec:
  localIp:
    ipAddress:
      ipAddress:
        ipv4:
          addr: 192.168.0.10
      virtualNetworkType:
        public: {}
  params:
    ipsec:
      ipsecPsk:
        clearSecretInfo:
          url: string://<base64>
  remoteIp:
    ip:
      ipv4:
        addr: 192.168.0.10
status: []
systemMetadata:
  creationTimestamp: "2020-10-19T09:49:22.496017200Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  tenant: acmecorp
  uid: 10dcdf68-350b-41a4-9043-312ac4cef52c

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build185306297_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/tunnels/tunnel-1?response_format=0'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 19 Oct 2020 09:49:22 GMT
Vary: Accept-Encoding

{
  "object": {
    "metadata": {
      "name": "tunnel-1",
      "namespace": "documentation",
      "uid": "10dcdf68-350b-41a4-9043-312ac4cef52c",
      "labels": {
      },
      "annotations": {
      },
      "description": "",
      "disable": false
    },
    "system_metadata": {
      "uid": "10dcdf68-350b-41a4-9043-312ac4cef52c",
      "creation_timestamp": "2020-10-19T09:49:22.496017200Z",
      "deletion_timestamp": null,
      "modification_timestamp": null,
      "initializers": null,
      "finalizers": [
      ],
      "tenant": "acmecorp",
      "creator_class": "examplesvc",
      "creator_id": "examplesvc",
      "creator_cookie": "",
      "trace_info": "6d4a58f82607d83c:6d4a58f82607d83c:0:1",
      "object_index": 0,
      "namespace": [
        {
          "kind": "namespace",
          "uid": "",
          "tenant": "acmecorp",
          "namespace": "",
          "name": "documentation"
        }
      ],
      "owner_view": null
    },
    "spec": {
      "gc_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"
              },
              "secret_encoding_type": "EncodingNone"
            }
          }
        }
      }
    }
  },
  "create_form": null,
  "replace_form": null,
  "resource_version": "754",
  "metadata": {
    "name": "tunnel-1",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "10dcdf68-350b-41a4-9043-312ac4cef52c",
    "creation_timestamp": "2020-10-19T09:49:22.496017200Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null
  },
  "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"
          },
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  },
  "status": [
  ]
}