Netgate TNSR Logo
API docs by Redocly

netgate-snmp API (24.10)

This YANG module provides a data model for SNMP Services.

Copyright 2019-2020 Rubicon Communications, LLC.

snmp-config

returns netgate.snmp.SnmpConfig

Simple Network Management Protocol (SNMP) configuration.

Responses

Request samples 

package main

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

func main() {

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

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

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

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

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

}

Response samples

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

creates netgate.snmp.SnmpConfig

Simple Network Management Protocol (SNMP) configuration.

Request Body schema: application/yang-data+json

netgate.snmp.SnmpConfig to be added to list

object (netgate.snmp.snmpconfig.Dataplane)

Dataplane-specific parameters of SNMP server.

netgate-snmp:snmp-enable
boolean
Default: false

Enable the SNMP daemons.

object (netgate.snmp.snmpconfig.SnmpAccessControl)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:dataplane": {
    },
  • "netgate-snmp:snmp-enable": false,
  • "netgate-snmp:snmp-access-control": {
    }
}

creates or updates netgate.snmp.SnmpConfig

Simple Network Management Protocol (SNMP) configuration.

Request Body schema: application/yang-data+json

netgate.snmp.SnmpConfig to be added or updated

object (netgate.snmp.SnmpConfig)

Simple Network Management Protocol (SNMP) configuration.

Responses

Request samples

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

removes netgate.snmp.SnmpConfig

Simple Network Management Protocol (SNMP) configuration.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-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.snmp.snmpconfig.Dataplane

Dataplane-specific parameters of SNMP server.

Responses

Request samples 

package main

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

func main() {

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

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

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

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

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

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-snmp:dataplane": {
    }
}

creates netgate.snmp.snmpconfig.Dataplane

Dataplane-specific parameters of SNMP server.

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.Dataplane to be added to list

netgate-snmp:enable
boolean

If true, SNMP server is enabled for dataplane interfaces.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:enable": true
}

creates or updates netgate.snmp.snmpconfig.Dataplane

Dataplane-specific parameters of SNMP server.

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.Dataplane to be added or updated

object (netgate.snmp.snmpconfig.Dataplane)

Dataplane-specific parameters of SNMP server.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:dataplane": {
    }
}

removes netgate.snmp.snmpconfig.Dataplane

Dataplane-specific parameters of SNMP server.

Responses

Request samples 

package main

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

func main() {

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

	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.snmp.snmpconfig.SnmpAccessControl

returns netgate.snmp.snmpconfig.SnmpAccessControl

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control"

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

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

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

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

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-snmp:snmp-access-control": {
    }
}

creates netgate.snmp.snmpconfig.SnmpAccessControl

creates netgate.snmp.snmpconfig.SnmpAccessControl

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.SnmpAccessControl to be added to list

Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.View)

Defines a subset of the OID tree.

Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.Access)

Map from group to views.

Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap)

Map community name from SNMP request to security name.

Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.Group)

Map security name to group.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:view": [
    ],
  • "netgate-snmp:access": [
    ],
  • "netgate-snmp:community-map": [
    ],
  • "netgate-snmp:group": [
    ]
}

creates or updates netgate.snmp.snmpconfig.SnmpAccessControl

creates or updates netgate.snmp.snmpconfig.SnmpAccessControl

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.SnmpAccessControl to be added or updated

object (netgate.snmp.snmpconfig.SnmpAccessControl)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:snmp-access-control": {
    }
}

removes netgate.snmp.snmpconfig.SnmpAccessControl

removes netgate.snmp.snmpconfig.SnmpAccessControl

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control"

	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.snmp.snmpconfig.snmpaccesscontrol.Access

Map from group to views.

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.Access to be added to list

netgate-snmp:group-name
string
Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:group-name": "string",
  • "netgate-snmp:access-entry": [
    ]
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.Access

Map from group to views.

path Parameters
group-name
required
string

Id of access

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access=%7Bgroup-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

Content type
application/yang-data+json
{
  • "netgate-snmp:access": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.Access

Map from group to views.

path Parameters
group-name
required
string

Id of access

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.Access to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.Access)

Map from group to views.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:access": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.Access

Map from group to views.

path Parameters
group-name
required
string

Id of access

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access=%7Bgroup-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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

creates netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

path Parameters
group-name
required
string

Id of access

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry to be added to list

netgate-snmp:security-level
string (netgate.snmp.SnmpSecurityLevel)
Value: "noauth"
netgate-snmp:context
string
netgate-snmp:read
string

View to use for read ops.

netgate-snmp:write
string

View to use for write ops.

netgate-snmp:security-model
string (netgate.snmp.SnmpSecurityModel)
Enum: "any" "v1" "v2c"
netgate-snmp:prefix
string (netgate.snmp.SnmpContextMatch)
Value: "exact"

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:security-level": "noauth",
  • "netgate-snmp:context": "string",
  • "netgate-snmp:read": "string",
  • "netgate-snmp:write": "string",
  • "netgate-snmp:security-model": "any",
  • "netgate-snmp:prefix": "exact"
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

returns netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

path Parameters
group-name
required
string

Id of access

context
required
string

Id of access-entry

prefix
required
string

Id of access-entry

security-model
required
string

Id of access-entry

security-level
required
string

Id of access-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access=%7Bgroup-name%7D/access-entry=%7Bcontext%7D,%7Bprefix%7D,%7Bsecurity-model%7D,%7Bsecurity-level%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
{
  • "netgate-snmp:access-entry": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

path Parameters
group-name
required
string

Id of access

context
required
string

Id of access-entry

prefix
required
string

Id of access-entry

security-model
required
string

Id of access-entry

security-level
required
string

Id of access-entry

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:access-entry": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

removes netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

path Parameters
group-name
required
string

Id of access

context
required
string

Id of access-entry

prefix
required
string

Id of access-entry

security-model
required
string

Id of access-entry

security-level
required
string

Id of access-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access=%7Bgroup-name%7D/access-entry=%7Bcontext%7D,%7Bprefix%7D,%7Bsecurity-model%7D,%7Bsecurity-level%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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

Map community name from SNMP request to security name.

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap to be added to list

netgate-snmp:community-name
string

Community name.

Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:community-name": "string",
  • "netgate-snmp:map-entry": [
    ]
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

Map community name from SNMP request to security name.

path Parameters
community-name
required
string

Id of community-map

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map=%7Bcommunity-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

Content type
application/yang-data+json
{
  • "netgate-snmp:community-map": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

Map community name from SNMP request to security name.

path Parameters
community-name
required
string

Id of community-map

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap)

Map community name from SNMP request to security name.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:community-map": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

Map community name from SNMP request to security name.

path Parameters
community-name
required
string

Id of community-map

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map=%7Bcommunity-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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

creates netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

path Parameters
community-name
required
string

Id of community-map

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry to be added to list

netgate-snmp:context
string

SNMPv3 context.

netgate-snmp:security-name
string

Security name.

netgate-snmp:source
string

Host name or IP address for source host.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:context": "string",
  • "netgate-snmp:security-name": "string",
  • "netgate-snmp:source": "string"
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

returns netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

path Parameters
community-name
required
string

Id of community-map

context
required
string

Id of map-entry

source
required
string

Id of map-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map=%7Bcommunity-name%7D/map-entry=%7Bcontext%7D,%7Bsource%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
{
  • "netgate-snmp:map-entry": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

path Parameters
community-name
required
string

Id of community-map

context
required
string

Id of map-entry

source
required
string

Id of map-entry

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:map-entry": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

removes netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

path Parameters
community-name
required
string

Id of community-map

context
required
string

Id of map-entry

source
required
string

Id of map-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map=%7Bcommunity-name%7D/map-entry=%7Bcontext%7D,%7Bsource%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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.Group

Map security name to group.

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.Group to be added to list

Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry)
netgate-snmp:group-name
string

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:group-entry": [
    ],
  • "netgate-snmp:group-name": "string"
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.Group

Map security name to group.

path Parameters
group-name
required
string

Id of group

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group=%7Bgroup-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

Content type
application/yang-data+json
{
  • "netgate-snmp:group": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.Group

Map security name to group.

path Parameters
group-name
required
string

Id of group

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.Group to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.Group)

Map security name to group.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:group": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.Group

Map security name to group.

path Parameters
group-name
required
string

Id of group

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group=%7Bgroup-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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

creates netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

path Parameters
group-name
required
string

Id of group

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry to be added to list

netgate-snmp:security-model
string (netgate.snmp.SnmpSecurityModel)
Enum: "any" "v1" "v2c"
netgate-snmp:security-name
string

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:security-model": "any",
  • "netgate-snmp:security-name": "string"
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

returns netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

path Parameters
group-name
required
string

Id of group

security-name
required
string

Id of group-entry

security-model
required
string

Id of group-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group=%7Bgroup-name%7D/group-entry=%7Bsecurity-name%7D,%7Bsecurity-model%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
{
  • "netgate-snmp:group-entry": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

path Parameters
group-name
required
string

Id of group

security-name
required
string

Id of group-entry

security-model
required
string

Id of group-entry

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:group-entry": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

removes netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

path Parameters
group-name
required
string

Id of group

security-name
required
string

Id of group-entry

security-model
required
string

Id of group-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group=%7Bgroup-name%7D/group-entry=%7Bsecurity-name%7D,%7Bsecurity-model%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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.View

Defines a subset of the OID tree.

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.View to be added to list

netgate-snmp:view-name
string
Array of objects (netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:view-name": "string",
  • "netgate-snmp:view-entry": [
    ]
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.View

Defines a subset of the OID tree.

path Parameters
view-name
required
string

Id of view

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view=%7Bview-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

Content type
application/yang-data+json
{
  • "netgate-snmp:view": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.View

Defines a subset of the OID tree.

path Parameters
view-name
required
string

Id of view

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.View to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.View)

Defines a subset of the OID tree.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:view": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.View

Defines a subset of the OID tree.

path Parameters
view-name
required
string

Id of view

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view=%7Bview-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))

}

creates netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

creates netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

path Parameters
view-name
required
string

Id of view

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry to be added to list

netgate-snmp:type
string (netgate.snmp.SnmpViewType)
Enum: "included" "excluded"
netgate-snmp:oid
string

SNMP OID.

netgate-snmp:mask
string

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:type": "included",
  • "netgate-snmp:oid": "string",
  • "netgate-snmp:mask": "string"
}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

returns netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

path Parameters
view-name
required
string

Id of view

type
required
string

Id of view-entry

oid
required
string

Id of view-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view=%7Bview-name%7D/view-entry=%7Btype%7D,%7Boid%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
{
  • "netgate-snmp:view-entry": {
    }
}

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

creates or updates netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

path Parameters
view-name
required
string

Id of view

type
required
string

Id of view-entry

oid
required
string

Id of view-entry

Request Body schema: application/yang-data+json

netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry to be added or updated

object (netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry)

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-snmp:view-entry": {
    }
}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

removes netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

path Parameters
view-name
required
string

Id of view

type
required
string

Id of view-entry

oid
required
string

Id of view-entry

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view=%7Bview-name%7D/view-entry=%7Btype%7D,%7Boid%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))

}

snmp-control

operates on netgate.snmp.SnmpControl

operates on netgate.snmp.SnmpControl

Request Body schema: application/yang-data+json
object (netgate.snmp.snmpcontrol.Input)

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}

snmp-coredump

operates on netgate.snmp.SnmpCoredump

operates on netgate.snmp.SnmpCoredump

Request Body schema: application/yang-data+json
object (netgate.snmp.snmpcoredump.Input)

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}