netgate-trace API (24.02)

This YANG module provides packet tracing operations.

trace-filter-clear

<no summary>

post /operations/netgate-trace:trace-filter-clear

Example URL

https://hostname/restconf/operations/netgate-trace:trace-filter-clear

Responses

201

No response

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-trace:trace-filter-clear"

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

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

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

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

}

trace-filter-set

operates on netgate.trace.TraceFilterSet

post /operations/netgate-trace:trace-filter-set

Example URL

https://hostname/restconf/operations/netgate-trace:trace-filter-set

operates on netgate.trace.TraceFilterSet

Request Body schema: application/yang-data+json

input

object (netgate.trace.tracefilterset.Input)

Responses

201

No response

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"input":
{
- "filter":
  {
  - "max-packets": 0,
  - "type": "include",
  - "node-name": "string"
  }
}

}

trace-packets-capture

operates on netgate.trace.TracePacketsCapture

post /operations/netgate-trace:trace-packets-capture

Example URL

https://hostname/restconf/operations/netgate-trace:trace-packets-capture

operates on netgate.trace.TracePacketsCapture

Request Body schema: application/yang-data+json

input

object (netgate.trace.tracepacketscapture.Input)

Responses

201

No response

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"input":
{
- "filter": false,
- "max-packets": 50,
- "pre-clear": false,
- "node-name": "string",
- "verbose": false
}

}

trace-packets-clear

<no summary>

post /operations/netgate-trace:trace-packets-clear

Example URL

https://hostname/restconf/operations/netgate-trace:trace-packets-clear

Responses

201

No response

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-trace:trace-packets-clear"

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

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

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

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

}

trace-packets-get

operates on netgate.trace.TracePacketsGet

post /operations/netgate-trace:trace-packets-get

Example URL

https://hostname/restconf/operations/netgate-trace:trace-packets-get

operates on netgate.trace.TracePacketsGet

Request Body schema: application/yang-data+json

input

object (netgate.trace.tracepacketsget.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"input":
{
- "max-packets": 50
}

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"output":
{
- "packets":
  {
  - "packet":
    [
    {
    "number": 0,
    "log": "string",
    "thread-id": 0
    }
    ]
  }
}

}