Show BGP communities global

POST

/

v2

/

api

/

show_bgp_communities_global

cURL

curl -sk -X POST "https://${CONTROLLER}/v2/api/show_bgp_communities_global" \
  -H "Authorization: cid ${CID}"

import requests

url = f"https://{CONTROLLER}/v2/api/show_bgp_communities_global"
headers = {"Authorization": f"cid {cid}"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://"+controller+"/v2/api/show_bgp_communities_global", nil)
  req.Header.Set("Authorization", "cid "+cid)

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Body

application/json

CID

string

The opaque session ID token. Required for 7.2 controllers only.

action

string

The API action to perform. Required for 7.2 controllers only.

disable_auto_cloud_bgp_community

boolean

Disable automatically derived BGP community from cloud type and region.

disable_bgp_communities_global

boolean

Disable BGP communities for all peers.

enable_auto_cloud_bgp_community

boolean

Enable automatically derived BGP community from cloud type and region.

enable_bgp_communities_global

boolean

Enable BGP communities for all peers.

set_bgp_max_hops

string

Set controller BGP maximum hops.

show_auto_cloud_bgp_community

boolean

Show auto-derived BGP communities setting.

show_bgp_max_hops

boolean

Show ontroller BGP maximum hops.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X POST "https://${CONTROLLER}/v2/api/show_bgp_communities_global" \
  -H "Authorization: cid ${CID}"

import requests

url = f"https://{CONTROLLER}/v2/api/show_bgp_communities_global"
headers = {"Authorization": f"cid {cid}"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://"+controller+"/v2/api/show_bgp_communities_global", nil)
  req.Header.Set("Authorization", "cid "+cid)

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}