Netgate TNSR Logo
API docs by Redocly

netgate-route API (24.06)

Container for routing related YANG models.

Consider carefully when modifying this file. It serves primarily as a point for the actual models for the routing to attach to via an augment statement.

Copyright 2017-2020 Rubicon Communications, LLC. All rights reserved.

route-config

returns netgate.route.RouteConfig

Root container for routing models

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-config"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-route:route-config": {
    }
}

creates netgate.route.RouteConfig

Root container for routing models

Request Body schema: application/yang-data+json

netgate.route.RouteConfig to be added to list

object (netgate.abf.routeconfig.AclBasedForwarding)

ACL based forwarding.

object (netgate.route.routeconfig.Dynamic)
static
object (netgate.route.routeconfig.Static)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-abf:acl-based-forwarding": {
    },
  • "dynamic": {
    },
  • "static": { }
}

creates or updates netgate.route.RouteConfig

Root container for routing models

Request Body schema: application/yang-data+json

netgate.route.RouteConfig to be added or updated

object (netgate.route.RouteConfig)

Root container for routing models

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-route:route-config": {
    }
}

removes netgate.route.RouteConfig

Root container for routing models

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-config"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.route.routeconfig.Dynamic

returns netgate.route.routeconfig.Dynamic

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-config/dynamic"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-route:dynamic": {
    }
}

creates netgate.route.routeconfig.Dynamic

creates netgate.route.routeconfig.Dynamic

Request Body schema: application/yang-data+json

netgate.route.routeconfig.Dynamic to be added to list

object (netgate.bgp.routeconfig.dynamic.Bgp)
object (netgate.frr.routeconfig.dynamic.RouteMaps)

Table of Route Maps, indexed by name. Each entry contains a set of rules ordered by sequence number.

object (netgate.frr.routeconfig.dynamic.PrefixLists)

Table of Prefix lists, indexed by name. Each entry contains a set of rules ordered by sequence number.

object (netgate.frr.routeconfig.dynamic.Manager)
object (netgate.frr.routeconfig.dynamic.AccessLists)

Table of Access Lists, indexed by name. Each entry contains a set of rules ordered by sequence number.

object (netgate.ospf.routestate.dynamic.Ospf)
object (netgate.ospf6.routestate.dynamic.Ospf6)
object (netgate.rip.routestate.dynamic.Rip)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-bgp:bgp": {
    },
  • "netgate-frr:route-maps": {
    },
  • "netgate-frr:prefix-lists": {
    },
  • "netgate-frr:manager": {
    },
  • "netgate-frr:access-lists": {
    },
  • "netgate-ospf:ospf": {
    },
  • "netgate-ospf6:ospf6": {
    },
  • "netgate-rip:rip": {
    }
}

creates or updates netgate.route.routeconfig.Dynamic

creates or updates netgate.route.routeconfig.Dynamic

Request Body schema: application/yang-data+json

netgate.route.routeconfig.Dynamic to be added or updated

object (netgate.route.routeconfig.Dynamic)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-route:dynamic": {
    }
}

removes netgate.route.routeconfig.Dynamic

removes netgate.route.routeconfig.Dynamic

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-config/dynamic"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.route.routeconfig.Static

returns netgate.route.routeconfig.Static

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-config/static"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-route:static": { }
}

creates netgate.route.routeconfig.Static

creates netgate.route.routeconfig.Static

Request Body schema: application/yang-data+json

netgate.route.routeconfig.Static to be added to list

object (netgate.route.routeconfig.Static)

Responses

Request samples

Content type
application/yang-data+json
{ }

creates or updates netgate.route.routeconfig.Static

creates or updates netgate.route.routeconfig.Static

Request Body schema: application/yang-data+json

netgate.route.routeconfig.Static to be added or updated

netgate-route:static
object (netgate.route.routeconfig.Static)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-route:static": { }
}

removes netgate.route.routeconfig.Static

removes netgate.route.routeconfig.Static

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-config/static"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

route-state

returns netgate.route.RouteState

Root container for routing models

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-state"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-route:route-state": {
    }
}

returns netgate.route.routestate.Dynamic

returns netgate.route.routestate.Dynamic

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-state/dynamic"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-route:dynamic": {
    }
}

returns netgate.route.routestate.Static

returns netgate.route.routestate.Static

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-route:route-state/static"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-route:static": { }
}