snmp-server community read¶
Define a read only community string
read Specification¶
Parameter
Value
Type
Collection
Object Key(s)
user
Collection Name
Collection URI
/axapi/v3/snmp-server/community/read
Element Name
read
Element URI
/axapi/v3/snmp-server/community/read/{user}
Element Attributes
read_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/snmp-server/community/read | ||
Create List | POST | /axapi/v3/snmp-server/community/read | ||
Get Object | GET | /axapi/v3/snmp-server/community/read/{user} | ||
Get List | GET | /axapi/v3/snmp-server/community/read | ||
Modify Object | POST | /axapi/v3/snmp-server/community/read/{user} | ||
Replace Object | PUT | /axapi/v3/snmp-server/community/read/{user} | ||
Replace List | PUT | /axapi/v3/snmp-server/community/read | ||
Delete Object | DELETE | /axapi/v3/snmp-server/community/read/{user} | ||
read-list¶
read-list is JSON List of read attributes
read-list : [
]
read attributes¶
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
Maximum Length: 31 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
remote¶
Specification
Value
Type
object
host-list
Type: List
ipv4-list
Type: List
ipv6-list
Type: List
remote_host-list¶
Specification
Value
Type
list
Block object keys
dns-host
Description DNS remote host
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
ipv4-mask
Description IPV4 mask
Type: string
Format: ipv4-netmask
remote_ipv4-list¶
Specification
Value
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
Value
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
oid-list¶
Specification
Value
Type
list
Block object keys
oid-val
Description specific the oid (The oid value, object-key)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
remote
Description: remote is a JSON Block. Please see below for oid-list_remote
Type: Object
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
oid-list_remote¶
Specification
Value
Type
object
host-list
Type: List
ipv4-list
Type: List
ipv6-list
Type: List
oid-list_remote_host-list¶
Specification
Value
Type
list
Block object keys
dns-host
Description DNS remote host
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
ipv4-mask
Description IPV4 mask
Type: string
Format: ipv4-netmask
oid-list_remote_ipv4-list¶
Specification
Value
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
Value
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