netgate-route API (23.02)

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.

route-config

returns netgate.route.RouteConfig

get /data/netgate-route:route-config

Example URL

https://hostname/restconf/data/netgate-route:route-config

Root container for routing models

Responses

200

netgate.route.RouteConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Copy

Expand all Collapse all

{

"netgate-route:route-config-wrapper":
{
- "netgate-route:route-config":
  {
  - "acl-based-forwarding":
    {
    "policies":
    {
    "policy":
    [
    {
    "ipv4":
    {
    "ipv4-next-hop":
    [
    {
    "drop": false,
    "if-name": "string",
    "ipv4-address": "string",
    "hop-id": 0,
    "null-send-unreachable": false,
    "weight": 0,
    "null-send-prohibited": false,
    "local": false
    }
    ]
    },
    "acl-name": "string",
    "policy-id": 0,
    "ipv6":
    {
    "ipv6-next-hop":
    [
    {
    "drop": false,
    "if-name": "string",
    "hop-id": 0,
    "null-send-unreachable": false,
    "weight": 0,
    "null-send-prohibited": false,
    "local": false,
    "ipv6-address": "string"
    }
    ]
    }
    }
    ]
    },
    "interfaces":
    {
    "interface":
    [
    {
    "name": "string",
    "policy-attachments":
    {
    "attachment":
    [
    {
    "priority": 0,
    "policy-id": 0,
    "address-family": "ipv4"
    }
    ]
    }
    }
    ]
    }
    },
  - "dynamic":
    {
    "bgp":
    {
    "rpki":
    {
    "global-options":
    {
    "enable": false,
    "debug":
    {
    "rpki": false
    }
    },
    "polling-period": 0,
    "retry-interval": 0,
    "expire-interval": 0,
    "cache-servers":
    {
    "server":
    [
    {
    "transport-type": "tcp",
    "host": "string",
    "transport":
    {
    "ssh":
    {
    "source": "string",
    "server-public-key": "string",
    "user-name": "string",
    "private-key": "string"
    }
    },
    "port": 0,
    "preference": 0
    }
    ]
    }
    },
    "global-options":
    {
    "debug":
    {
    "zebra":
    {
    "all": false,
    "prefix": "string"
    },
    "neighbor-events":
    {
    "all": false,
    "peer": "string"
    },
    "as4":
    {
    "all": false,
    "segment": false
    },
    "bestpath":
    {
    "ipv4-prefixes":
    {
    "ipv4-prefix":
    [
    "string"
    ]
    },
    "ipv6-prefix": "string",
    "ipv6-prefixes":
    {
    "ipv6-prefix":
    [
    "string"
    ]
    }
    },
    "keepalive":
    {
    "all": false,
    "peer": "string"
    },
    "update-groups": false,
    "nht": false,
    "updates":
    {
    "all": false,
    "prefixes":
    {
    "prefix":
    [
    "string"
    ]
    },
    "in-peers":
    {
    "peer":
    [
    "string"
    ]
    },
    "out-peers":
    {
    "peer":
    [
    "string"
    ]
    }
    }
    },
    "route-map-delay-timer": 0,
    "enable": false
    },
    "as-path-table":
    {
    "as-path":
    [
    {
    "name": "string",
    "patterns":
    {
    "pattern":
    [
    {
    "sequence": 0,
    "regex": "string",
    "policy": "deny"
    }
    ]
    }
    }
    ]
    },
    "routers":
    {
    "router":
    [
    {
    "always-compare-med": false,
    "listen-limit": 0,
    "bestpath-compare-routerid": false,
    "bestpath-as-path-multipath-relax-as-set": false,
    "address-families":
    {
    "ipv4":
    {
    "multicast":
    {
    "distance-admin":
    {
    "ip-src-prefix": "string",
    "distance": 0,
    "access-list-name": "string"
    },
    "distance-bgp":
    {
    "internal": 0,
    "external": 0,
    "local": 0
    },
    "neighbors":
    {
    "neighbor":
    [
    {
    "as-override": false,
    "remove-private-as":
    {
    "all": false,
    "replace-as": false
    },
    "send-community":
    {
    "standard": true,
    "large": true,
    "extended": true
    },
    "route-map-in": "string",
    "route-server-client": false,
    "prefix-list-in": "string",
    "filter-list-in": "string",
    "soft-reconfiguration-inbound": false,
    "allowas-in":
    {
    "origin": false,
    "occurences": 0
    },
    "peer": "string",
    "route-map-out": "string",
    "filter-list-out": "string",
    "prefix-list-out": "string",
    "distribute-list-out": "string",
    "attribute-unchanged":
    {
    "attr":
    [
    "string"
    ]
    },
    "distribute-list-in": "string",
    "capability-advertise":
    {
    "orf-prefix-list": "send"
    },
    "addpath-tx-bestpath-per-as": false,
    "unsuppress-route-map": "string",
    "next-hop-self": false,
    "weight": 0,
    "addpath-tx-all-paths": false,
    "route-reflector-client": false,
    "activate": false,
    "default-originate":
    {
    "route-map": "string"
    },
    "next-hop-self-force": false,
    "maximum-prefix":
    {
    "limit": 0,
    "warning-threshold": 0,
    "warning-only": false,
    "restart-interval": 0
    }
    }
    ]
    },
    "table-map": "string",
    "network-announcements":
    {
    "network":
    [
    {
    "ip-prefix": "string",
    "announcement":
    {
    "backdoor": false,
    "route-map-name": "string"
    }
    }
    ]
    },
    "aggregations":
    {
    "aggregation":
    [
    {
    "ip-address": "string",
    "aggregation-data":
    {
    "as-set": false,
    "summary-only": false
    }
    }
    ]
    }
    },
    "unicast":
    {
    "multiple-path-maximums":
    {
    "ibgp-paths": 0,
    "equal-cluster-length": false,
    "non-ibgp-paths": 0
    },
    "distance-admin":
    {
    "ip-src-prefix": "string",
    "distance": 0,
    "access-list-name": "string"
    },
    "distance-bgp":
    {
    "internal": 0,
    "external": 0,
    "local": 0
    },
    "neighbors":
    {
    "neighbor":
    [
    {
    "as-override": false,
    "remove-private-as":
    {
    "all": false,
    "replace-as": false
    },
    "send-community":
    {
    "standard": true,
    "large": true,
    "extended": true
    },
    "route-map-in": "string",
    "route-server-client": false,
    "prefix-list-in": "string",
    "filter-list-in": "string",
    "soft-reconfiguration-inbound": false,
    "allowas-in":
    {
    "origin": false,
    "occurences": 0
    },
    "peer": "string",
    "route-map-out": "string",
    "filter-list-out": "string",
    "prefix-list-out": "string",
    "distribute-list-out": "string",
    "attribute-unchanged":
    {
    "attr":
    [
    "string"
    ]
    },
    "distribute-list-in": "string",
    "capability-advertise":
    {
    "orf-prefix-list": "send"
    },
    "addpath-tx-bestpath-per-as": false,
    "unsuppress-route-map": "string",
    "next-hop-self": false,
    "weight": 0,
    "addpath-tx-all-paths": false,
    "route-reflector-client": false,
    "activate": false,
    "default-originate":
    {
    "route-map": "string"
    },
    "next-hop-self-force": false,
    "maximum-prefix":
    {
    "limit": 0,
    "warning-threshold": 0,
    "warning-only": false,
    "restart-interval": 0
    }
    }
    ]
    },
    "table-map": "string",
    "network-imports":
    {
    "route-map-imports":
    [
    {
    "route-map-import": "string"
    }
    ],
    "vrf-import":
    [
    {
    "vrf-id-import": "string"
    }
    ]
    },
    "redistributions":
    {
    "named-sources":
    {
    "route-source":
    [
    {
    "route-data":
    {
    "route-map": "string",
    "metric": 0
    },
    "source": "kernel"
    }
    ]
    },
    "kernel-tables":
    {
    "table":
    [
    {
    "table-data":
    {
    "route-map": "string",
    "metric": 0
    },
    "id": 0
    }
    ]
    }
    },
    "network-announcements":
    {
    "network":
    [
    {
    "ip-prefix": "string",
    "announcement":
    {
    "backdoor": false,
    "route-map-name": "string"
    }
    }
    ]
    },
    "aggregations":
    {
    "aggregation":
    [
    {
    "ip-address": "string",
    "aggregation-data":
    {
    "as-set": false,
    "summary-only": false
    }
    }
    ]
    }
    }
    },
    "ipv6":
    {
    "multicast":
    {
    "distance-admin":
    {
    "ip-src-prefix": "string",
    "distance": 0,
    "access-list-name": "string"
    },
    "network-announcements":
    {
    "network":
    [
    {
    "ip-prefix": "string",
    "announcement":
    {
    "route-map-name": "string"
    }
    }
    ]
    },
    "distance-bgp":
    {
    "internal": 0,
    "external": 0,
    "local": 0
    },
    "neighbors":
    {
    "neighbor":
    [
    {
    "as-override": false,
    "remove-private-as":
    {
    "all": false,
    "replace-as": false
    },
    "send-community":
    {
    "standard": true,
    "large": true,
    "extended": true
    },
    "route-map-in": "string",
    "route-server-client": false,
    "prefix-list-in": "string",
    "filter-list-in": "string",
    "soft-reconfiguration-inbound": false,
    "allowas-in":
    {
    "origin": false,
    "occurences": 0
    },
    "peer": "string",
    "route-map-out": "string",
    "filter-list-out": "string",
    "prefix-list-out": "string",
    "distribute-list-out": "string",
    "attribute-unchanged":
    {
    "attr":
    [
    "string"
    ]
    },
    "distribute-list-in": "string",
    "capability-advertise":
    {
    "orf-prefix-list": "send"
    },
    "addpath-tx-bestpath-per-as": false,
    "unsuppress-route-map": "string",
    "next-hop-self": false,
    "weight": 0,
    "addpath-tx-all-paths": false,
    "route-reflector-client": false,
    "activate": false,
    "default-originate":
    {
    "route-map": "string"
    },
    "next-hop-self-force": false,
    "maximum-prefix":
    {
    "limit": 0,
    "warning-threshold": 0,
    "warning-only": false,
    "restart-interval": 0
    }
    }
    ]
    }
    },
    "unicast":
    {
    "multiple-path-maximums":
    {
    "ibgp-paths": 0,
    "equal-cluster-length": false,
    "non-ibgp-paths": 0
    },
    "distance-admin":
    {
    "ip-src-prefix": "string",
    "distance": 0,
    "access-list-name": "string"
    },
    "distance-bgp":
    {
    "internal": 0,
    "external": 0,
    "local": 0
    },
    "neighbors":
    {
    "neighbor":
    [
    {
    "as-override": false,
    "remove-private-as":
    {
    "all": false,
    "replace-as": false
    },
    "send-community":
    {
    "standard": true,
    "large": true,
    "extended": true
    },
    "route-map-in": "string",
    "route-server-client": false,
    "prefix-list-in": "string",
    "filter-list-in": "string",
    "soft-reconfiguration-inbound": false,
    "allowas-in":
    {
    "origin": false,
    "occurences": 0
    },
    "peer": "string",
    "route-map-out": "string",
    "filter-list-out": "string",
    "prefix-list-out": "string",
    "distribute-list-out": "string",
    "attribute-unchanged":
    {
    "attr":
    [
    "string"
    ]
    },
    "distribute-list-in": "string",
    "capability-advertise":
    {
    "orf-prefix-list": "send"
    },
    "addpath-tx-bestpath-per-as": false,
    "unsuppress-route-map": "string",
    "next-hop-self": false,
    "weight": 0,
    "addpath-tx-all-paths": false,
    "route-reflector-client": false,
    "activate": false,
    "default-originate":
    {
    "route-map": "string"
    },
    "next-hop-self-force": false,
    "maximum-prefix":
    {
    "limit": 0,
    "warning-threshold": 0,
    "warning-only": false,
    "restart-interval": 0
    }
    }
    ]
    },
    "table-map": "string",
    "network-imports":
    {
    "route-map-imports":
    [
    {
    "route-map-import": "string"
    }
    ],
    "vrf-import":
    [
    {
    "vrf-id-import": "string"
    }
    ]
    },
    "redistributions":
    {
    "named-sources":
    {
    "route-source":
    [
    {
    "route-data":
    {
    "route-map": "string",
    "metric": 0
    },
    "source": "kernel"
    }
    ]
    },
    "kernel-tables":
    {
    "table":
    [
    {
    "table-data":
    {
    "route-map": "string",
    "metric": 0
    },
    "id": 0
    }
    ]
    }
    },
    "network-announcements":
    {
    "network":
    [
    {
    "ip-prefix": "string",
    "announcement":
    {
    "route-map-name": "string"
    }
    }
    ]
    },
    "aggregations":
    {
    "aggregation":
    [
    {
    "ip-address": "string",
    "aggregation-data":
    {
    "summary-only": false
    }
    }
    ]
    }
    }
    }
    },
    "bestpath-as-path-multipath-relax": false,
    "bestpath-as-path-ignore": false,
    "update-delay-peer-wait": 0,
    "bestpath-as-path-confed": false,
    "network-import-check": true,
    "dampening":
    {
    "penalty-half-life": 0,
    "route-suppression-maximum": 0,
    "route-reuse": 0,
    "route-suppression": 0
    },
    "vrf-id": "string",
    "router-id": "string",
    "neighbors":
    {
    "neighbor":
    [
    {
    "local-as-replace-as": false,
    "advertisement-interval": 0,
    "ttl-security-hops": 0,
    "peer-group-name": "string",
    "description": "string",
    "remote-asn": 0,
    "ebgp-multihop":
    {
    "max-hop-count": 0
    },
    "password": "string",
    "enable": false,
    "peer": "string",
    "capability-negotiate": true,
    "capability-advertise":
    {
    "extended-nexthop": false,
    "dynamic": false
    },
    "bfd": false,
    "timers":
    {
    "keep-alive": 0,
    "hold-time": 0,
    "connect": 0
    },
    "local-as-number": 0,
    "solo": false,
    "passive": false,
    "enforce-first-as": false,
    "disable-connected-check": false,
    "strict-capability-match": false,
    "port": 0,
    "update-source": "string",
    "local-as-no-prepend": false,
    "override-capability": false
    }
    ]
    },
    "log-neighbor-changes": false,
    "max-med":
    {
    "on-startup":
    {
    "time-period": 0,
    "med-value": 0
    },
    "administrative":
    {
    "med-value": 0
    }
    },
    "allow-martian-nexthop": false,
    "confederation":
    {
    "peers":
    {
    "peer":
    [
    0
    ]
    },
    "identifier": 0
    },
    "cluster-id": "string",
    "write-quanta": 0,
    "timers":
    {
    "hold-time": 0,
    "keep-alive": 0
    },
    "disable-ebgp-connected-route-check": false,
    "ebgp-requires-policy": true,
    "listen-peer-group-name": "string",
    "defaults":
    {
    "ipv4-unicast-enabled": true
    },
    "update-delay-updates": 0,
    "bestpath-med":
    {
    "missing-as-worst": false,
    "confed": false
    },
    "listen-range": "string",
    "deterministic-med": false,
    "coalesce-time": 0,
    "asn": 0,
    "route-reflector-allow-outbound-policy": false,
    "client-to-client-reflection": false
    }
    ]
    },
    "community-lists":
    {
    "community":
    [
    {
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "sequence": 0,
    "action": "deny",
    "soo": "string",
    "rt": "string",
    "community": "string"