netgate-snort API (25.02)

YANG module to fully support the controls of the Snort VPP plugin via TNSR.

snort-config

returns netgate.snort.SnortConfig

Snort plugin configuration parameters.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-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

200

Content type

application/yang-data+json

{"netgate-snort:snort-config": {"netgate-snort:mode": "polling",
"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
]
}
}
}

creates netgate.snort.SnortConfig

Snort plugin configuration parameters.

Request Body schema: application/yang-data+json

netgate.snort.SnortConfig to be added to list

netgate-snort:mode	string (netgate.snort.SnortNodeModeT) Enum: "polling" "interrupt"
	object (netgate.snort.snortconfig.Instances) Remote servers.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:mode": "polling",
"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
]
}
}

creates or updates netgate.snort.SnortConfig

Snort plugin configuration parameters.

Request Body schema: application/yang-data+json

netgate.snort.SnortConfig to be added or updated

object (netgate.snort.SnortConfig)

Snort plugin configuration parameters.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:snort-config": {"netgate-snort:mode": "polling",
"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
]
}
}
}

removes netgate.snort.SnortConfig

Snort plugin configuration parameters.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-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.snort.snortconfig.Instances

Remote servers.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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

200

Content type

application/yang-data+json

{"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
]
}
}

creates netgate.snort.snortconfig.Instances

Remote servers.

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.Instances to be added to list

Array of objects (netgate.snort.snortconfig.instances.Instance)

Instance name.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instance": [{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
]
}

creates or updates netgate.snort.snortconfig.Instances

Remote servers.

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.Instances to be added or updated

object (netgate.snort.snortconfig.Instances)

Remote servers.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
]
}
}

removes netgate.snort.snortconfig.Instances

Remote servers.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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.snort.snortconfig.instances.Instance

Instance name.

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.instances.Instance to be added to list

netgate-snort:output	string (netgate.snort.SnortAlertOutputT) Enum: "fast" "full" "syslog" "json" "csv" "unixsock"
	object (netgate.snort.snortconfig.instances.instance.Interfaces) Attached interfaces.
netgate-snort:enable	boolean If true a client for the instance is started.
netgate-snort:queue-size	integer <int32> Queue size (2 power)
netgate-snort:name	string Instance name.
netgate-snort:action	string (netgate.snort.SnortActionT) Enum: "detect" "prevent"
netgate-snort:description	string A text description for the instance.
netgate-snort:on-disconnect	string (netgate.snort.SnortOnDisconnectT) Enum: "pass" "drop"

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}

returns netgate.snort.snortconfig.instances.Instance

Instance name.

path Parameters

name

required

string

Id of instance

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-config/instances/instance=%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

200

Content type

application/yang-data+json

{"netgate-snort:instance": {"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
}

creates or updates netgate.snort.snortconfig.instances.Instance

Instance name.

path Parameters

name

required

string

Id of instance

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.instances.Instance to be added or updated

object (netgate.snort.snortconfig.instances.Instance)

Instance name.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instance": {"netgate-snort:output": "fast",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
},
"netgate-snort:enable": true,
"netgate-snort:queue-size": 0,
"netgate-snort:name": "string",
"netgate-snort:action": "detect",
"netgate-snort:description": "string",
"netgate-snort:on-disconnect": "pass"
}
}

removes netgate.snort.snortconfig.instances.Instance

Instance name.

path Parameters

name

required

string

Id of instance

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-config/instances/instance=%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.snort.snortconfig.instances.instance.Interfaces

Attached interfaces.

path Parameters

name

required

string

Id of instance

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-config/instances/instance=%7Bname%7D/interfaces"

	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

200

Content type

application/yang-data+json

{"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
}
}

creates netgate.snort.snortconfig.instances.instance.Interfaces

Attached interfaces.

path Parameters

name

required

string

Id of instance

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.instances.instance.Interfaces to be added to list

Array of objects (netgate.snort.snortconfig.instances.instance.interfaces.Interface)

Interface name.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
}

creates or updates netgate.snort.snortconfig.instances.instance.Interfaces

Attached interfaces.

path Parameters

name

required

string

Id of instance

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.instances.instance.Interfaces to be added or updated

object (netgate.snort.snortconfig.instances.instance.Interfaces)

Attached interfaces.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
]
}
}

removes netgate.snort.snortconfig.instances.instance.Interfaces

Attached interfaces.

path Parameters

name

required

string

Id of instance

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-config/instances/instance=%7Bname%7D/interfaces"

	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.snort.snortconfig.instances.instance.interfaces.Interface

Interface name.

path Parameters

name

required

string

Id of instance

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.instances.instance.interfaces.Interface to be added to list

netgate-snort:name	string Interface name.
netgate-snort:direction	string (netgate.snort.Direction) Enum: "in" "out" "both"

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}

returns netgate.snort.snortconfig.instances.instance.interfaces.Interface

Interface name.

path Parameters

name required	string Id of instance
interface-name required	string Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-config/instances/instance=%7Bname%7D/interfaces/interface=%7Binterface-name%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

200

Content type

application/yang-data+json

{"netgate-snort:interface": {"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
}

creates or updates netgate.snort.snortconfig.instances.instance.interfaces.Interface

Interface name.

path Parameters

name required	string Id of instance
interface-name required	string Id of interface

Request Body schema: application/yang-data+json

netgate.snort.snortconfig.instances.instance.interfaces.Interface to be added or updated

object (netgate.snort.snortconfig.instances.instance.interfaces.Interface)

Interface name.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:interface": {"netgate-snort:name": "string",
"netgate-snort:direction": "in"
}
}

removes netgate.snort.snortconfig.instances.instance.interfaces.Interface

Interface name.

path Parameters

name required	string Id of instance
interface-name required	string Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-config/instances/instance=%7Bname%7D/interfaces/interface=%7Binterface-name%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))

}

snort-state

returns netgate.snort.SnortState

Snort state.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-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

200

Content type

application/yang-data+json

{"netgate-snort:snort-state": {"netgate-snort:mode": "polling",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
]
},
"netgate-snort:clients": {"netgate-snort:client": [{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
]
},
"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
]
}
}
}

creates netgate.snort.SnortState

Snort state.

Request Body schema: application/yang-data+json

netgate.snort.SnortState to be added to list

netgate-snort:mode	string (netgate.snort.SnortNodeModeT) Enum: "polling" "interrupt"
	object (netgate.snort.snortstate.Interfaces) Attached interfaces.
	object (netgate.snort.snortstate.Clients) Connected clients.
	object (netgate.snort.snortstate.Instances) Packet provider instance.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:mode": "polling",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
]
},
"netgate-snort:clients": {"netgate-snort:client": [{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
]
},
"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
]
}
}

creates or updates netgate.snort.SnortState

Snort state.

Request Body schema: application/yang-data+json

netgate.snort.SnortState to be added or updated

object (netgate.snort.SnortState)

Snort state.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:snort-state": {"netgate-snort:mode": "polling",
"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
]
},
"netgate-snort:clients": {"netgate-snort:client": [{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
]
},
"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
]
}
}
}

removes netgate.snort.SnortState

Snort state.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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.snort.snortstate.Clients

Connected clients.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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

200

Content type

application/yang-data+json

{"netgate-snort:clients": {"netgate-snort:client": [{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
]
}
}

creates netgate.snort.snortstate.Clients

Connected clients.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.Clients to be added to list

Array of objects (netgate.snort.snortstate.clients.Client)

Keyed by client index.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:client": [{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
]
}

creates or updates netgate.snort.snortstate.Clients

Connected clients.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.Clients to be added or updated

object (netgate.snort.snortstate.Clients)

Connected clients.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:clients": {"netgate-snort:client": [{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
]
}
}

removes netgate.snort.snortstate.Clients

Connected clients.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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.snort.snortstate.clients.Client

Keyed by client index.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.clients.Client to be added to list

netgate-snort:instance-name	string Snort instance name
netgate-snort:client-index	integer <int64> Client index.
netgate-snort:instance-index	integer <int64> Snort instance index.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}

returns netgate.snort.snortstate.clients.Client

Keyed by client index.

path Parameters

client-index

required

integer <int64>

Id of client

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-state/clients/client=%7Bclient-index%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

200

Content type

application/yang-data+json

{"netgate-snort:client": {"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
}

creates or updates netgate.snort.snortstate.clients.Client

Keyed by client index.

path Parameters

client-index

required

integer <int64>

Id of client

Request Body schema: application/yang-data+json

netgate.snort.snortstate.clients.Client to be added or updated

object (netgate.snort.snortstate.clients.Client)

Keyed by client index.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:client": {"netgate-snort:instance-name": "string",
"netgate-snort:client-index": 0,
"netgate-snort:instance-index": 0
}
}

removes netgate.snort.snortstate.clients.Client

Keyed by client index.

path Parameters

client-index

required

integer <int64>

Id of client

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-state/clients/client=%7Bclient-index%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.snort.snortstate.Instances

Packet provider instance.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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

200

Content type

application/yang-data+json

{"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
]
}
}

creates netgate.snort.snortstate.Instances

Packet provider instance.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.Instances to be added to list

Array of objects (netgate.snort.snortstate.instances.Instance)

Keyed by name.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instance": [{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
]
}

creates or updates netgate.snort.snortstate.Instances

Packet provider instance.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.Instances to be added or updated

object (netgate.snort.snortstate.Instances)

Packet provider instance.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instances": {"netgate-snort:instance": [{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
]
}
}

removes netgate.snort.snortstate.Instances

Packet provider instance.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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.snort.snortstate.instances.Instance

Keyed by name.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.instances.Instance to be added to list

netgate-snort:name	string Instance name.
netgate-snort:shm-size	integer <int64> Amount of allocated memory
netgate-snort:client	integer <int32> Client index. (-1 if not connected)
netgate-snort:index	integer <int64> Pool index.
netgate-snort:shm-fd	integer <int32> Shared memory file descriptor.
netgate-snort:on-disconnect	string (netgate.snort.SnortOnDisconnectT) Enum: "pass" "drop"

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}

returns netgate.snort.snortstate.instances.Instance

Keyed by name.

path Parameters

name

required

string

Id of instance

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-state/instances/instance=%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

200

Content type

application/yang-data+json

{"netgate-snort:instance": {"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
}

creates or updates netgate.snort.snortstate.instances.Instance

Keyed by name.

path Parameters

name

required

string

Id of instance

Request Body schema: application/yang-data+json

netgate.snort.snortstate.instances.Instance to be added or updated

object (netgate.snort.snortstate.instances.Instance)

Keyed by name.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:instance": {"netgate-snort:name": "string",
"netgate-snort:shm-size": 0,
"netgate-snort:client": 0,
"netgate-snort:index": 0,
"netgate-snort:shm-fd": 0,
"netgate-snort:on-disconnect": "pass"
}
}

removes netgate.snort.snortstate.instances.Instance

Keyed by name.

path Parameters

name

required

string

Id of instance

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-state/instances/instance=%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.snort.snortstate.Interfaces

Attached interfaces.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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

200

Content type

application/yang-data+json

{"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
]
}
}

creates netgate.snort.snortstate.Interfaces

Attached interfaces.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.Interfaces to be added to list

Array of objects (netgate.snort.snortstate.interfaces.Interface)

Keyed by interface index.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:interface": [{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
]
}

creates or updates netgate.snort.snortstate.Interfaces

Attached interfaces.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.Interfaces to be added or updated

object (netgate.snort.snortstate.Interfaces)

Attached interfaces.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:interfaces": {"netgate-snort:interface": [{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
]
}
}

removes netgate.snort.snortstate.Interfaces

Attached interfaces.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

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

	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.snort.snortstate.interfaces.Interface

Keyed by interface index.

Request Body schema: application/yang-data+json

netgate.snort.snortstate.interfaces.Interface to be added to list

netgate-snort:if-name	string Human readable name.
netgate-snort:instance-name	string Snort instance name
netgate-snort:if-index	integer <int64> Instance name.
netgate-snort:instance-index	integer <int64> Snort instance index.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}

returns netgate.snort.snortstate.interfaces.Interface

Keyed by interface index.

path Parameters

if-index

required

integer <int64>

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-state/interfaces/interface=%7Bif-index%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

200

Content type

application/yang-data+json

{"netgate-snort:interface": {"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
}

creates or updates netgate.snort.snortstate.interfaces.Interface

Keyed by interface index.

path Parameters

if-index

required

integer <int64>

Id of interface

Request Body schema: application/yang-data+json

netgate.snort.snortstate.interfaces.Interface to be added or updated

object (netgate.snort.snortstate.interfaces.Interface)

Keyed by interface index.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-snort:interface": {"netgate-snort:if-name": "string",
"netgate-snort:instance-name": "string",
"netgate-snort:if-index": 0,
"netgate-snort:instance-index": 0
}
}

removes netgate.snort.snortstate.interfaces.Interface

Keyed by interface index.

path Parameters

if-index

required

integer <int64>

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snort:snort-state/interfaces/interface=%7Bif-index%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))

}

snort-client-control

operates on netgate.snort.SnortClientControl

Request Body schema: application/yang-data+json

object (netgate.snort.snortclientcontrol.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-snort:name": "string",
"netgate-snort:operation": "start"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-snort:stdout": "string"
}
}

snort-disconnect

operates on netgate.snort.SnortDisconnect

Request Body schema: application/yang-data+json

object (netgate.snort.snortdisconnect.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-snort:name": "string"
}
}

snort-refresh

/operations/netgate-snort:snort-refresh

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-snort:snort-refresh"

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

}