snmp-server host¶
Specify hosts to receive SNMP traps
host Specification¶
Parameter Value Type Intermediate Resource Element Name host Element URI /axapi/v3/snmp-server/host Element Attributes host_attributes Partition Visibility shared Schema host schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/snmp-server/host | host_attributes |
host attributes¶
host-name-list
Type: List
Reference Object: /axapi/v3/snmp-server/host/host-name/{hostname}+{version}
ipv4-host-list
Type: List
Reference Object: /axapi/v3/snmp-server/host/ipv4-host/{ipv4-addr}+{version}
ipv6-host-list
Type: List
Reference Object: /axapi/v3/snmp-server/host/ipv6-host/{ipv6-addr}+{version}
ipv6-host-list¶
Specification Value Type list Block object keys ipv6-addr
Description IPV6 address of SNMP trap host
Type: string
Format: ipv6-address
udp-port
Description The trap host’s UDP port number(default: 162)
Type: number
Range: 1-65535
Default: 162
user
Description SNMPv3 user to send traps (User Name)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
v1-v2c-comm
Description SNMPv1/v2c community string
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
version
Description ‘v1’: Use SNMPv1; ‘v2c’: Use SNMPv2c; ‘v3’: User SNMPv3;
Type: string
Supported Values: v1, v2c, v3
Default: v2c
host-name-list¶
Specification Value Type list Block object keys hostname
Description Hostname of SNMP trap host
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
udp-port
Description The trap host’s UDP port number(default: 162)
Type: number
Range: 1-65535
Default: 162
user
Description SNMPv3 user to send traps (User Name)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
v1-v2c-comm
Description SNMPv1/v2c community string
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
version
Description ‘v1’: Use SNMPv1; ‘v2c’: Use SNMPv2c; ‘v3’: User SNMPv3;
Type: string
Supported Values: v1, v2c, v3
Default: v2c
ipv4-host-list¶
Specification Value Type list Block object keys ipv4-addr
Description IPV4 address of SNMP trap host
Type: string
Format: ipv4-address
udp-port
Description The trap host’s UDP port number(default: 162)
Type: number
Range: 1-65535
Default: 162
user
Description SNMPv3 user to send traps (User Name)
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
v1-v2c-comm
Description SNMPv1/v2c community string
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
version
Description ‘v1’: Use SNMPv1; ‘v2c’: Use SNMPv2c; ‘v3’: User SNMPv3;
Type: string
Supported Values: v1, v2c, v3
Default: v2c