ves-io-schema-bgp-API-Get

Examples of getting bgp

Usecase:

Get bgp object bgp-peering from system

Request using vesctl:

vesctl configuration get bgp bgp-peering --namespace system

vesctl yaml response:

object:
  metadata:
    annotations: {}
    labels: {}
    name: bgp-peering
    namespace: system
    uid: 952e8047-f30b-45a4-8b50-5dc005fe576d
  spec:
    gcSpec:
      bgpParameters:
        asn: 64512
      bgpPeers:
      - asn: 64512
        port: 179
      networkInterface:
      - kind: network_interface
        name: eth0
        namespace: system
        tenant: acmecorp
      where:
        virtualSite:
          ref:
          - kind: virtual_site
            name: acmecrop-vsite1
            namespace: system
            tenant: acmecorp
  systemMetadata:
    creationTimestamp: "2020-05-15T10:52:31.067068633Z"
    creatorClass: examplesvc.ves.io
    finalizers: []
    namespace:
    - kind: namespace
      name: system
      tenant: acmecorp
    tenant: acmecorp
    traceInfo: 375875f0ec304f9b:375875f0ec304f9b:0:1
    uid: 952e8047-f30b-45a4-8b50-5dc005fe576d
resourceVersion: "63"
status: []

Request using curl:

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

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 15 May 2020 10:52:31 GMT
Vary: Accept-Encoding

{
  "object": {
    "metadata": {
      "name": "bgp-peering",
      "namespace": "system",
      "uid": "952e8047-f30b-45a4-8b50-5dc005fe576d",
      "labels": {
      },
      "annotations": {
      },
      "description": "",
      "disable": false
    },
    "system_metadata": {
      "uid": "952e8047-f30b-45a4-8b50-5dc005fe576d",
      "creation_timestamp": "2020-05-15T10:52:31.067068633Z",
      "deletion_timestamp": null,
      "modification_timestamp": null,
      "initializers": null,
      "finalizers": [
      ],
      "tenant": "acmecorp",
      "creator_class": "examplesvc.ves.io",
      "creator_id": "",
      "creator_cookie": "",
      "trace_info": "375875f0ec304f9b:375875f0ec304f9b:0:1",
      "object_index": 0,
      "namespace": [
        {
          "kind": "namespace",
          "uid": "",
          "tenant": "acmecorp",
          "namespace": "",
          "name": "system"
        }
      ],
      "owner_view": null
    },
    "spec": {
      "gc_spec": {
        "where": {
          "virtual_site": {
            "ref": [
              {
                "kind": "virtual_site",
                "uid": "",
                "tenant": "acmecorp",
                "namespace": "system",
                "name": "acmecrop-vsite1"
              }
            ],
            "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
          }
        },
        "bgp_parameters": {
          "asn": 64512,
          "bgp_router_id_type": "BGP_ROUTER_ID_FROM_INTERFACE",
          "bgp_router_id": null,
          "bgp_router_id_key": ""
        },
        "bgp_peers": [
          {
            "asn": 64512,
            "bgp_peer_address_type": "BGP_PEER_ADDRESS_FROM_DEFAULT_GW",
            "bgp_peer_address": null,
            "bgp_peer_address_key": "",
            "port": 179,
            "bgp_peer_subnet_offset": 0
          }
        ],
        "network_interface": [
          {
            "kind": "network_interface",
            "uid": "",
            "tenant": "acmecorp",
            "namespace": "system",
            "name": "eth0"
          }
        ]
      }
    }
  },
  "create_form": null,
  "replace_form": null,
  "resource_version": "63",
  "metadata": null,
  "system_metadata": null,
  "spec": null,
  "status": [
  ]
}