netgate-snmp API (24.02)

This YANG module provides a data model for SNMP Services.

snmp-config

returns netgate.snmp.SnmpConfig

get /data/netgate-snmp:snmp-config

Example URL

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

returns netgate.snmp.SnmpConfig

Responses

200

netgate.snmp.SnmpConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:snmp-config-wrapper":
{
- "netgate-snmp:snmp-config":
  {
  - "dataplane":
    {
    "enable": false
    },
  - "snmp-access-control":
    {
    "view":
    [
    {
    "view-name": "string",
    "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
    }
    ],
    "access":
    [
    {
    "group-name": "string",
    "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
    }
    ],
    "community-map":
    [
    {
    "community-name": "string",
    "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
    }
    ],
    "group":
    [
    {
    "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
    "group-name": "string"
    }
    ]
    },
  - "snmp-enable": false
  }
}

}

creates netgate.snmp.SnmpConfig

post /data/netgate-snmp:snmp-config

Example URL

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

creates netgate.snmp.SnmpConfig

Request Body schema: application/yang-data+json

netgate.snmp.SnmpConfig to be added to list

netgate-snmp:snmp-config

object (netgate.snmp.SnmpConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:snmp-config":
{
- "dataplane":
  {
  - "enable": false
  },
- "snmp-access-control":
  {
  - "view":
    [
    {
    "view-name": "string",
    "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
    }
    ],
  - "access":
    [
    {
    "group-name": "string",
    "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
    }
    ],
  - "community-map":
    [
    {
    "community-name": "string",
    "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
    }
    ],
  - "group":
    [
    {
    "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
    "group-name": "string"
    }
    ]
  },
- "snmp-enable": false
}

}

creates or updates netgate.snmp.SnmpConfig

put /data/netgate-snmp:snmp-config

Example URL

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

creates or updates netgate.snmp.SnmpConfig

Request Body schema: application/yang-data+json

netgate.snmp.SnmpConfig to be added or updated

netgate-snmp:snmp-config-wrapper

object (netgate.snmp.SnmpConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:snmp-config-wrapper":
{
- "netgate-snmp:snmp-config":
  {
  - "dataplane":
    {
    "enable": false
    },
  - "snmp-access-control":
    {
    "view":
    [
    {
    "view-name": "string",
    "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
    }
    ],
    "access":
    [
    {
    "group-name": "string",
    "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
    }
    ],
    "community-map":
    [
    {
    "community-name": "string",
    "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
    }
    ],
    "group":
    [
    {
    "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
    "group-name": "string"
    }
    ]
    },
  - "snmp-enable": false
  }
}

}

removes netgate.snmp.SnmpConfig

delete /data/netgate-snmp:snmp-config

Example URL

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

removes netgate.snmp.SnmpConfig

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

get /data/netgate-snmp:snmp-config/dataplane

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/dataplane

Dataplane-specific parameters of SNMP server.

Responses

200

netgate.snmp.snmpconfig.Dataplane

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:dataplane-wrapper":
{
- "dataplane":
  {
  - "enable": false
  }
}

}

creates netgate.snmp.snmpconfig.Dataplane

post /data/netgate-snmp:snmp-config/dataplane

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/dataplane

Dataplane-specific parameters of SNMP server.

Request Body schema: application/yang-data+json

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

dataplane

object (netgate.snmp.snmpconfig.Dataplane)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"dataplane":
{
- "enable": false
}

}

creates or updates netgate.snmp.snmpconfig.Dataplane

put /data/netgate-snmp:snmp-config/dataplane

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/dataplane

Dataplane-specific parameters of SNMP server.

Request Body schema: application/yang-data+json

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

netgate-snmp:dataplane-wrapper

object (netgate.snmp.snmpconfig.DataplaneWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:dataplane-wrapper":
{
- "dataplane":
  {
  - "enable": false
  }
}

}

removes netgate.snmp.snmpconfig.Dataplane

delete /data/netgate-snmp:snmp-config/dataplane

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/dataplane

Dataplane-specific parameters of SNMP server.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

get /data/netgate-snmp:snmp-config/snmp-access-control

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control

returns netgate.snmp.snmpconfig.SnmpAccessControl

Responses

200

netgate.snmp.snmpconfig.SnmpAccessControl

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:snmp-access-control-wrapper":
{
- "snmp-access-control":
  {
  - "view":
    [
    {
    "view-name": "string",
    "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
    }
    ],
  - "access":
    [
    {
    "group-name": "string",
    "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
    }
    ],
  - "community-map":
    [
    {
    "community-name": "string",
    "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
    }
    ],
  - "group":
    [
    {
    "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
    "group-name": "string"
    }
    ]
  }
}

}

creates netgate.snmp.snmpconfig.SnmpAccessControl

post /data/netgate-snmp:snmp-config/snmp-access-control

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control

creates netgate.snmp.snmpconfig.SnmpAccessControl

Request Body schema: application/yang-data+json

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

snmp-access-control

object (netgate.snmp.snmpconfig.SnmpAccessControl)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"snmp-access-control":
{
- "view":
  [
  - {
    "view-name": "string",
    "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
    }
  ],
- "access":
  [
  - {
    "group-name": "string",
    "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
    }
  ],
- "community-map":
  [
  - {
    "community-name": "string",
    "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
    }
  ],
- "group":
  [
  - {
    "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
    "group-name": "string"
    }
  ]
}

}

creates or updates netgate.snmp.snmpconfig.SnmpAccessControl

put /data/netgate-snmp:snmp-config/snmp-access-control

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control

creates or updates netgate.snmp.snmpconfig.SnmpAccessControl

Request Body schema: application/yang-data+json

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

netgate-snmp:snmp-access-control-wrapper

object (netgate.snmp.snmpconfig.SnmpAccessControlWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:snmp-access-control-wrapper":
{
- "snmp-access-control":
  {
  - "view":
    [
    {
    "view-name": "string",
    "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
    }
    ],
  - "access":
    [
    {
    "group-name": "string",
    "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
    }
    ],
  - "community-map":
    [
    {
    "community-name": "string",
    "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
    }
    ],
  - "group":
    [
    {
    "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
    "group-name": "string"
    }
    ]
  }
}

}

removes netgate.snmp.snmpconfig.SnmpAccessControl

delete /data/netgate-snmp:snmp-config/snmp-access-control

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control

removes netgate.snmp.snmpconfig.SnmpAccessControl

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/access

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access

Map from group to views.

Request Body schema: application/yang-data+json

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

access

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"access":
{
- "group-name": "string",
- "access-entry":
  [
  - {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
  ]
}

}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.Access

get /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}

Map from group to views.

path Parameters

group-name

required

string

Id of access

Responses

200

netgate.snmp.snmpconfig.snmpaccesscontrol.Access

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:access-wrapper":
{
- "access":
  {
  - "group-name": "string",
  - "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}

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

netgate-snmp:access-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:access-wrapper":
{
- "access":
  {
  - "group-name": "string",
  - "access-entry":
    [
    {
    "security-level": "noauth",
    "read": "string",
    "security-model": "any",
    "prefix": "exact",
    "context": "string",
    "write": "string"
    }
    ]
  }
}

}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.Access

delete /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}

Map from group to views.

path Parameters

group-name

required

string

Id of access

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry

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

access-entry

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"access-entry":
{
- "security-level": "noauth",
- "read": "string",
- "security-model": "any",
- "prefix": "exact",
- "context": "string",
- "write": "string"
}

}

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

get /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry={context},{prefix},{security-model},{security-level}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry={context},{prefix},{security-model},{security-level}

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

200

netgate.snmp.snmpconfig.snmpaccesscontrol.access.AccessEntry

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:access-entry-wrapper":
{
- "access-entry":
  {
  - "security-level": "noauth",
  - "read": "string",
  - "security-model": "any",
  - "prefix": "exact",
  - "context": "string",
  - "write": "string"
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry={context},{prefix},{security-model},{security-level}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry={context},{prefix},{security-model},{security-level}

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

netgate-snmp:access-entry-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:access-entry-wrapper":
{
- "access-entry":
  {
  - "security-level": "noauth",
  - "read": "string",
  - "security-model": "any",
  - "prefix": "exact",
  - "context": "string",
  - "write": "string"
  }
}

}

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

delete /data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry={context},{prefix},{security-model},{security-level}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/access={group-name}/access-entry={context},{prefix},{security-model},{security-level}

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

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/community-map

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map

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

community-map

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"community-map":
{
- "community-name": "string",
- "map-entry":
  [
  - {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
  ]
}

}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

get /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}

Map community name from SNMP request to security name.

path Parameters

community-name

required

string

Id of community-map

Responses

200

netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:community-map-wrapper":
{
- "community-map":
  {
  - "community-name": "string",
  - "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}

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

netgate-snmp:community-map-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:community-map-wrapper":
{
- "community-map":
  {
  - "community-name": "string",
  - "map-entry":
    [
    {
    "context": "string",
    "security-name": "string",
    "source": "string"
    }
    ]
  }
}

}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.CommunityMap

delete /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}

Map community name from SNMP request to security name.

path Parameters

community-name

required

string

Id of community-map

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry

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

map-entry

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"map-entry":
{
- "context": "string",
- "security-name": "string",
- "source": "string"
}

}

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

get /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry={context},{source}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry={context},{source}

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

200

netgate.snmp.snmpconfig.snmpaccesscontrol.communitymap.MapEntry

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:map-entry-wrapper":
{
- "map-entry":
  {
  - "context": "string",
  - "security-name": "string",
  - "source": "string"
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry={context},{source}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry={context},{source}

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

netgate-snmp:map-entry-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:map-entry-wrapper":
{
- "map-entry":
  {
  - "context": "string",
  - "security-name": "string",
  - "source": "string"
  }
}

}

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

delete /data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry={context},{source}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/community-map={community-name}/map-entry={context},{source}

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

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/group

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group

Map security name to group.

Request Body schema: application/yang-data+json

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

group

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"group":
{
- "group-entry":
  [
  - {
    "security-model": "any",
    "security-name": "string"
    }
  ],
- "group-name": "string"
}

}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.Group

get /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}

Map security name to group.

path Parameters

group-name

required

string

Id of group

Responses

200

netgate.snmp.snmpconfig.snmpaccesscontrol.Group

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:group-wrapper":
{
- "group":
  {
  - "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
  - "group-name": "string"
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}

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

netgate-snmp:group-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:group-wrapper":
{
- "group":
  {
  - "group-entry":
    [
    {
    "security-model": "any",
    "security-name": "string"
    }
    ],
  - "group-name": "string"
  }
}

}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.Group

delete /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}

Map security name to group.

path Parameters

group-name

required

string

Id of group

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry

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

group-entry

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"group-entry":
{
- "security-model": "any",
- "security-name": "string"
}

}

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

get /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry={security-name},{security-model}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry={security-name},{security-model}

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

200

netgate.snmp.snmpconfig.snmpaccesscontrol.group.GroupEntry

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:group-entry-wrapper":
{
- "group-entry":
  {
  - "security-model": "any",
  - "security-name": "string"
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry={security-name},{security-model}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry={security-name},{security-model}

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

netgate-snmp:group-entry-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:group-entry-wrapper":
{
- "group-entry":
  {
  - "security-model": "any",
  - "security-name": "string"
  }
}

}

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

delete /data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry={security-name},{security-model}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/group={group-name}/group-entry={security-name},{security-model}

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

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/view

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"view":
{
- "view-name": "string",
- "view-entry":
  [
  - {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
  ]
}

}

returns netgate.snmp.snmpconfig.snmpaccesscontrol.View

get /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}

Defines a subset of the OID tree.

path Parameters

view-name

required

string

Id of view

Responses

200

netgate.snmp.snmpconfig.snmpaccesscontrol.View

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:view-wrapper":
{
- "view":
  {
  - "view-name": "string",
  - "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}

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

netgate-snmp:view-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:view-wrapper":
{
- "view":
  {
  - "view-name": "string",
  - "view-entry":
    [
    {
    "oid": "string",
    "type": "included",
    "mask": "string"
    }
    ]
  }
}

}

removes netgate.snmp.snmpconfig.snmpaccesscontrol.View

delete /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}

Defines a subset of the OID tree.

path Parameters

view-name

required

string

Id of view

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry

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

view-entry

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"view-entry":
{
- "oid": "string",
- "type": "included",
- "mask": "string"
}

}

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

get /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry={type},{oid}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry={type},{oid}

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

200

netgate.snmp.snmpconfig.snmpaccesscontrol.view.ViewEntry

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

Copy

Expand all Collapse all

{

"netgate-snmp:view-entry-wrapper":
{
- "view-entry":
  {
  - "oid": "string",
  - "type": "included",
  - "mask": "string"
  }
}

}

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

put /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry={type},{oid}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry={type},{oid}

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

netgate-snmp:view-entry-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-snmp:view-entry-wrapper":
{
- "view-entry":
  {
  - "oid": "string",
  - "type": "included",
  - "mask": "string"
  }
}

}

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

delete /data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry={type},{oid}

Example URL

https://hostname/restconf/data/netgate-snmp:snmp-config/snmp-access-control/view={view-name}/view-entry={type},{oid}

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

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

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

post /operations/netgate-snmp:snmp-control

Example URL

https://hostname/restconf/operations/netgate-snmp:snmp-control

operates on netgate.snmp.SnmpControl

Request Body schema: application/yang-data+json

input

object (netgate.snmp.snmpcontrol.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":
{
- "namespace": "host",
- "operation": "start"
}

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

snmp-coredump

operates on netgate.snmp.SnmpCoredump

post /operations/netgate-snmp:snmp-coredump

Example URL

https://hostname/restconf/operations/netgate-snmp:snmp-coredump

operates on netgate.snmp.SnmpCoredump

Request Body schema: application/yang-data+json

input

object (netgate.snmp.snmpcoredump.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":
{
- "namespace": "host",
- "operation": "enable"
}

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}