snmp-server community

Define a community who can access the SNMP engine

community Specification

Type Intermediate Resource
Element Name community
Element URI /axapi/v3/snmp-server/community
Element Attributes community_attributes
Schema community schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/snmp-server/community

community_attributes

community Attributes

read-list

Description: read-list is a JSON List . Please see below for read-list

Type: List

Reference Object: /axapi/v3/snmp-server/community/read/{user}

read-list

Specification
Type list
Block object keys

oid-list

Description: oid-list is a JSON List . Please see below for l220_oid-list

Type: List

Reference Object: /axapi/v3/snmp-server/community/read/{user}/oid/{oid-val}

remote

Description: remote is a JSON Block . Please see below for l220_remote

Type: Object

user

Description: SNMPv1/v2c community string

Type: string

Format: string-rlx

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

read-list.oid-list

Specification
Type list
Block object keys

oid-val

Description: specific the oid (The oid value, object-key)

Type: string

remote

Description: remote is a JSON Block . Please see below for l220_remote

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

read-list.oid-list.remote

Specification
Type object

host-list

Description: host-list is a JSON List . Please see below for l220_host-list

Type: List

ipv4-list

Description: ipv4-list is a JSON List . Please see below for l220_ipv4-list

Type: List

ipv6-list

Description: ipv6-list is a JSON List . Please see below for l220_ipv6-list

Type: List

read-list.oid-list.remote.host-list

Specification
Type list
Block object keys

dns-host

Description: DNS remote host

Type: string

ipv4-mask

Description: IPV4 mask

Type: string

Format: ipv4-netmask

read-list.oid-list.remote.ipv4-list

Specification
Type list
Block object keys

ipv4-host

Description: IPV4 remote host

Type: string

Format: ipv4-address

ipv4-mask

Description: IPV4 mask

Type: string

Format: ipv4-netmask

read-list.oid-list.remote.ipv6-list

Specification
Type list
Block object keys

ipv6-host

Description: IPV6 remote host

Type: string

Format: ipv6-address

ipv6-mask

Description: IPV6 mask

Type: number

Range: 1-128

read-list.remote

Specification
Type object

host-list

Description: host-list is a JSON List . Please see below for l220_host-list

Type: List

ipv4-list

Description: ipv4-list is a JSON List . Please see below for l220_ipv4-list

Type: List

ipv6-list

Description: ipv6-list is a JSON List . Please see below for l220_ipv6-list

Type: List

read-list.remote.host-list

Specification
Type list
Block object keys

dns-host

Description: DNS remote host

Type: string

ipv4-mask

Description: IPV4 mask

Type: string

Format: ipv4-netmask

read-list.remote.ipv4-list

Specification
Type list
Block object keys

ipv4-host

Description: IPV4 remote host

Type: string

Format: ipv4-address

ipv4-mask

Description: IPV4 mask

Type: string

Format: ipv4-netmask

read-list.remote.ipv6-list

Specification
Type list
Block object keys

ipv6-host

Description: IPV6 remote host

Type: string

Format: ipv6-address

ipv6-mask

Description: IPV6 mask

Type: number

Range: 1-128