Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-packet-trace API (24.02)

This YANG module provides a Netgate-defined data-model for tracing packets using Classifier filters.

Copyright 2020 Rubicon Communications, LLC.

packet-trace-config

returns netgate.packet.trace.PacketTraceConfig

get /data/netgate-packet-trace:packet-trace-config

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config

Configuration for packet tracing filters.

Responses

200

netgate.packet.trace.PacketTraceConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-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-packet-trace:packet-trace-config-wrapper":
    {
    }
}

creates netgate.packet.trace.PacketTraceConfig

post /data/netgate-packet-trace:packet-trace-config

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config

Configuration for packet tracing filters.

Request Body schema: application/yang-data+json

netgate.packet.trace.PacketTraceConfig to be added to list

netgate-packet-trace:packet-trace-config
object (netgate.packet.trace.PacketTraceConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:packet-trace-config":
    {
    }
}

creates or updates netgate.packet.trace.PacketTraceConfig

put /data/netgate-packet-trace:packet-trace-config

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config

Configuration for packet tracing filters.

Request Body schema: application/yang-data+json

netgate.packet.trace.PacketTraceConfig to be added or updated

netgate-packet-trace:packet-trace-config-wrapper
object (netgate.packet.trace.PacketTraceConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:packet-trace-config-wrapper":
    {
    }
}

removes netgate.packet.trace.PacketTraceConfig

delete /data/netgate-packet-trace:packet-trace-config

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config

Configuration for packet tracing filters.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-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.packet.trace.packettraceconfig.Filters

get /data/netgate-packet-trace:packet-trace-config/filters

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters

Table of filters that select traced packets.

Responses

200

netgate.packet.trace.packettraceconfig.Filters

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters"

	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-packet-trace:filters-wrapper":
    {
    }
}

creates netgate.packet.trace.packettraceconfig.Filters

post /data/netgate-packet-trace:packet-trace-config/filters

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters

Table of filters that select traced packets.

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.Filters to be added to list

filters
object (netgate.packet.trace.packettraceconfig.Filters)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "filters":
    {
    }
}

creates or updates netgate.packet.trace.packettraceconfig.Filters

put /data/netgate-packet-trace:packet-trace-config/filters

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters

Table of filters that select traced packets.

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.Filters to be added or updated

netgate-packet-trace:filters-wrapper
object (netgate.packet.trace.packettraceconfig.FiltersWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:filters-wrapper":
    {
    }
}

removes netgate.packet.trace.packettraceconfig.Filters

delete /data/netgate-packet-trace:packet-trace-config/filters

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters

Table of filters that select traced packets.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters"

	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))

}

creates netgate.packet.trace.packettraceconfig.filters.Filter

post /data/netgate-packet-trace:packet-trace-config/filters/filter

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter

An unordered list of named filters.

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.Filter to be added to list

filter
object (netgate.packet.trace.packettraceconfig.filters.Filter)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "filter":
    {
    }
}

returns netgate.packet.trace.packettraceconfig.filters.Filter

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}

An unordered list of named filters.

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.trace.packettraceconfig.filters.Filter

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D"

	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-packet-trace:filter-wrapper":
    {
    }
}

creates or updates netgate.packet.trace.packettraceconfig.filters.Filter

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}

An unordered list of named filters.

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.Filter to be added or updated

netgate-packet-trace:filter-wrapper
object (netgate.packet.trace.packettraceconfig.filters.FilterWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:filter-wrapper":
    {
    }
}

removes netgate.packet.trace.packettraceconfig.filters.Filter

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}

An unordered list of named filters.

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D"

	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.packet.trace.packettraceconfig.filters.filter.Match

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Trace filter match values.

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.trace.packettraceconfig.filters.filter.Match

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match"

	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-packet-trace:match-wrapper":
    {
    }
}

creates netgate.packet.trace.packettraceconfig.filters.filter.Match

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Trace filter match values.

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.Match to be added to list

match
object (netgate.packet.trace.packettraceconfig.filters.filter.Match)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "match":
    {
    }
}

creates or updates netgate.packet.trace.packettraceconfig.filters.filter.Match

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Trace filter match values.

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.Match to be added or updated

netgate-packet-trace:match-wrapper
object (netgate.packet.trace.packettraceconfig.filters.filter.MatchWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:match-wrapper":
    {
    }
}

removes netgate.packet.trace.packettraceconfig.filters.filter.Match

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match

Trace filter match values.

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match"

	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.packet.trace.packettraceconfig.filters.filter.match.L2

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

L2 fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.trace.packettraceconfig.filters.filter.match.L2

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2"

	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-packet-trace:l2-wrapper":
    {
    }
}

creates netgate.packet.trace.packettraceconfig.filters.filter.match.L2

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

L2 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.match.L2 to be added to list

l2
object (netgate.packet.trace.packettraceconfig.filters.filter.match.L2)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "l2":
    {
    }
}

creates or updates netgate.packet.trace.packettraceconfig.filters.filter.match.L2

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

L2 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.match.L2 to be added or updated

netgate-packet-trace:l2-wrapper
object (netgate.packet.trace.packettraceconfig.filters.filter.match.L2Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l2-wrapper":
    {
    }
}

removes netgate.packet.trace.packettraceconfig.filters.filter.match.L2

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2

L2 fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2"

	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.packet.fields.L2Ethernet

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

L2 ethernet fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.L2Ethernet

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2/ethernet"

	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-packet-trace:l2-ethernet-wrapper":
    {
    }
}

creates netgate.packet.fields.L2Ethernet

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

L2 ethernet fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L2Ethernet to be added to list

ethernet
object (netgate.packet.fields.L2Ethernet)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "ethernet":
    {
    }
}

creates or updates netgate.packet.fields.L2Ethernet

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

L2 ethernet fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L2Ethernet to be added or updated

netgate-packet-trace:l2-ethernet-wrapper
object (netgate.packet.fields.L2EthernetWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l2-ethernet-wrapper":
    {
    }
}

removes netgate.packet.fields.L2Ethernet

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet

L2 ethernet fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2/ethernet"

	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.packet.fields.l2ethernet.VlanDot1q

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

returns netgate.packet.fields.l2ethernet.VlanDot1q

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.l2ethernet.VlanDot1q

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2/ethernet/vlan-dot1q"

	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-packet-trace:vlan-dot1q-wrapper":
    {
    }
}

creates netgate.packet.fields.l2ethernet.VlanDot1q

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

creates netgate.packet.fields.l2ethernet.VlanDot1q

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.l2ethernet.VlanDot1q to be added to list

vlan-dot1q
object (netgate.packet.fields.l2ethernet.VlanDot1q)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "vlan-dot1q":
    {
    }
}

creates or updates netgate.packet.fields.l2ethernet.VlanDot1q

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

creates or updates netgate.packet.fields.l2ethernet.VlanDot1q

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.l2ethernet.VlanDot1q to be added or updated

netgate-packet-trace:vlan-dot1q-wrapper
object (netgate.packet.fields.l2ethernet.VlanDot1qWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:vlan-dot1q-wrapper":
    {
    }
}

removes netgate.packet.fields.l2ethernet.VlanDot1q

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q

removes netgate.packet.fields.l2ethernet.VlanDot1q

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2/ethernet/vlan-dot1q"

	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.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

returns netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2/ethernet/vlan-dot1q/vlan-dot1ad"

	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-packet-trace:vlan-dot1ad-wrapper":
    {
    }
}

creates netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

creates netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad to be added to list

vlan-dot1ad
object (netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "vlan-dot1ad":
    {
    }
}

creates or updates netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

creates or updates netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad to be added or updated

netgate-packet-trace:vlan-dot1ad-wrapper
object (netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1adWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:vlan-dot1ad-wrapper":
    {
    }
}

removes netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l2/ethernet/vlan-dot1q/vlan-dot1ad

removes netgate.packet.fields.l2ethernet.vlandot1q.VlanDot1ad

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l2/ethernet/vlan-dot1q/vlan-dot1ad"

	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.packet.trace.packettraceconfig.filters.filter.match.L3

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

L3 fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.trace.packettraceconfig.filters.filter.match.L3

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l3"

	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-packet-trace:l3-wrapper":
    {
    }
}

creates netgate.packet.trace.packettraceconfig.filters.filter.match.L3

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

L3 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.match.L3 to be added to list

l3
object (netgate.packet.trace.packettraceconfig.filters.filter.match.L3)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "l3":
    {
    }
}

creates or updates netgate.packet.trace.packettraceconfig.filters.filter.match.L3

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

L3 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.match.L3 to be added or updated

netgate-packet-trace:l3-wrapper
object (netgate.packet.trace.packettraceconfig.filters.filter.match.L3Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l3-wrapper":
    {
    }
}

removes netgate.packet.trace.packettraceconfig.filters.filter.match.L3

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3

L3 fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l3"

	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.packet.fields.L3Ip4

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

L3 IPv4 fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.L3Ip4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l3/ipv4"

	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-packet-trace:l3-ip4-wrapper":
    {
    }
}

creates netgate.packet.fields.L3Ip4

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

L3 IPv4 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L3Ip4 to be added to list

ipv4
object (netgate.packet.fields.L3Ip4)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "ipv4":
    {
    }
}

creates or updates netgate.packet.fields.L3Ip4

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

L3 IPv4 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L3Ip4 to be added or updated

netgate-packet-trace:l3-ip4-wrapper
object (netgate.packet.fields.L3Ip4Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l3-ip4-wrapper":
    {
    }
}

removes netgate.packet.fields.L3Ip4

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv4

L3 IPv4 fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l3/ipv4"

	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.packet.fields.L3Ip6

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

L3 IPv6 fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.L3Ip6

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l3/ipv6"

	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-packet-trace:l3-ip6-wrapper":
    {
    }
}

creates netgate.packet.fields.L3Ip6

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

L3 IPv6 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L3Ip6 to be added to list

ipv6
object (netgate.packet.fields.L3Ip6)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "ipv6":
    {
    }
}

creates or updates netgate.packet.fields.L3Ip6

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

L3 IPv6 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L3Ip6 to be added or updated

netgate-packet-trace:l3-ip6-wrapper
object (netgate.packet.fields.L3Ip6Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l3-ip6-wrapper":
    {
    }
}

removes netgate.packet.fields.L3Ip6

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l3/ipv6

L3 IPv6 fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l3/ipv6"

	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.packet.trace.packettraceconfig.filters.filter.match.L4

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

L4 fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.trace.packettraceconfig.filters.filter.match.L4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l4"

	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-packet-trace:l4-wrapper":
    {
    }
}

creates netgate.packet.trace.packettraceconfig.filters.filter.match.L4

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

L4 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.match.L4 to be added to list

l4
object (netgate.packet.trace.packettraceconfig.filters.filter.match.L4)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "l4":
    {
    }
}

creates or updates netgate.packet.trace.packettraceconfig.filters.filter.match.L4

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

L4 fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.trace.packettraceconfig.filters.filter.match.L4 to be added or updated

netgate-packet-trace:l4-wrapper
object (netgate.packet.trace.packettraceconfig.filters.filter.match.L4Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l4-wrapper":
    {
    }
}

removes netgate.packet.trace.packettraceconfig.filters.filter.match.L4

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4

L4 fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l4"

	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.packet.fields.L4Tcp

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

L4 TCP fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.L4Tcp

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l4/tcp"

	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-packet-trace:l4-tcp-wrapper":
    {
    }
}

creates netgate.packet.fields.L4Tcp

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

L4 TCP fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L4Tcp to be added to list

tcp
object (netgate.packet.fields.L4Tcp)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "tcp":
    {
    }
}

creates or updates netgate.packet.fields.L4Tcp

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

L4 TCP fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L4Tcp to be added or updated

netgate-packet-trace:l4-tcp-wrapper
object (netgate.packet.fields.L4TcpWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l4-tcp-wrapper":
    {
    }
}

removes netgate.packet.fields.L4Tcp

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/tcp

L4 TCP fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l4/tcp"

	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.packet.fields.L4Udp

get /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

L4 UDP fields

path Parameters
name
required
string

Id of filter

Responses

200

netgate.packet.fields.L4Udp

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l4/udp"

	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-packet-trace:l4-udp-wrapper":
    {
    }
}

creates netgate.packet.fields.L4Udp

post /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

L4 UDP fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L4Udp to be added to list

udp
object (netgate.packet.fields.L4Udp)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "udp":
    {
    }
}

creates or updates netgate.packet.fields.L4Udp

put /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

L4 UDP fields

path Parameters
name
required
string

Id of filter

Request Body schema: application/yang-data+json

netgate.packet.fields.L4Udp to be added or updated

netgate-packet-trace:l4-udp-wrapper
object (netgate.packet.fields.L4UdpWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-packet-trace:l4-udp-wrapper":
    {
    }
}

removes netgate.packet.fields.L4Udp

delete /data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

Example URL

https://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter={name}/match/l4/udp

L4 UDP fields

path Parameters
name
required
string

Id of filter

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-packet-trace:packet-trace-config/filters/filter=%7Bname%7D/match/l4/udp"

	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))

}