ves-io-schema-tunnel-API-Get

Examples of getting tunnel

Usecase:

Get tunnel-1

Request using vesctl:

vesctl configuration get tunnel tunnel-1 --namespace system

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: tunnel-1
  namespace: system
referringObjects: []
resourceVersion: "1908"
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: "2022-05-09T09:48:01.983649128Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  labels: {}
  tenant: acmecorp
  uid: 8c672103-7720-477e-9c3c-59dd00765b75

Request using curl:

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

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Mon, 09 May 2022 09:48:01 GMT
Vary: Accept-Encoding
X-Volterra-Response-Fields-Deprecated: object

{
  "object": null,
  "create_form": null,
  "replace_form": null,
  "resource_version": "1908",
  "metadata": {
    "name": "tunnel-1",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "8c672103-7720-477e-9c3c-59dd00765b75",
    "creation_timestamp": "2022-05-09T09:48:01.983649128Z",
    "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"
        }
      }
    }
  },
  "status": [
  ],
  "referring_objects": [
  ]
}