Set gateway send BGP communities override

POST

/

v2

/

api

/

set_gateway_send_bgp_communities_override

cURL

curl -sk -X POST "https://<controller>/v2/api/set_gateway_send_bgp_communities_override" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/set_gateway_send_bgp_communities_override"
headers = {"Authorization": "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/set_gateway_send_bgp_communities_override", 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

gateway_name

string

required

BGP gateway name.

send_communities

string

required

Send BGP communities to peers.

CID

string

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

accept_communities

string

Accept BGP communities from peers.

action

string

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

bgp_hold_time

string

Configure BGP polling time (12-360)sec.

bgp_local_as_num

string

BGP local AS number.

bgp_neighbor_status_polling_time

integer

Configure BGP neighbor status polling time (1-10)sec.

bgp_polling_time

string

Configure BGP route polling time (10-50)sec.

dampening

enum<string>

Enable or disable bgp dampening.

Available options:

false,

true

mode

enum<string>

Enable or disable BGP GW configuration.

Available options:

disable,

enable

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/set_gateway_send_bgp_communities_override" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/set_gateway_send_bgp_communities_override"
headers = {"Authorization": "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/set_gateway_send_bgp_communities_override", 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
}