snmp-server community read

Define a read only community string

read Specification

Type Collection
Object Key(s) user
Collection Name read-list
Collection URI /axapi/v3/snmp-server/community/read/
Element Name read
Element URI /axapi/v3/snmp-server/community/read/{user}
Element Attributes read_attributes
Schema read schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/snmp-server/community/read/

read Attributes

Create List

POST

/axapi/v3/snmp-server/community/read/

read Attributes

Get Object

GET

/axapi/v3/snmp-server/community/read/{user}

read Attributes

Get List

GET

/axapi/v3/snmp-server/community/read/

read-list

Modify Object

POST

/axapi/v3/snmp-server/community/read/{user}

read Attributes

Replace Object

PUT

/axapi/v3/snmp-server/community/read/{user}

read Attributes

Replace List

PUT

/axapi/v3/snmp-server/community/read/

read-list

Delete Object

DELETE

/axapi/v3/snmp-server/community/read/{user}

read Attributes

read-list

read-list is JSON List of read Attributes

read-list : [

read Attributes

oid-list

Description: oid-list is a JSON List . Please see below for 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 remote

Type: Object

user

Description: SNMPv1/v2c community string

Type: string

Format: string-rlx

Required: Yes

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

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 remote

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

oid-list.remote

Specification
Type object

host-list

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

Type: List

ipv4-list

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

Type: List

ipv6-list

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

Type: 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

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

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

remote

Specification
Type object

host-list

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

Type: List

ipv4-list

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

Type: List

ipv6-list

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

Type: 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

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

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