SNMP
概览
开启SNMP管理后，第三方监控平台可获取云平台资源监控数据或接收云平台推送的报警消息。
清单
SNMP代理清单 (SNMP Agent Inventory)
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 请参见 资源属性 | 4.7.21 | ||
| version | SNMP代理使用协议版本 | 4.7.21 | ||
| readCommunity | 读团体字(version为v2c时使用) | 4.7.21 | ||
| userName | 用户名(version为v3时使用) | 4.7.21 | ||
| authAlgorithm | 认证算法 | 4.7.21 | ||
| authPassword | 认证密码 | 4.7.21 | ||
| privacyAlgorithm | 隐私算法 | 4.7.21 | ||
| privacyPassword | 隐私密码 | 4.7.21 | ||
| port | 端口 | 4.7.21 | ||
| status | SNMP代理是否启用 | 4.7.21 | ||
| securityLevel | 安全等级 | 4.7.21 | ||
| createDate | 请参见 资源属性 | 4.7.21 | ||
| lastOpDate | 请参见 资源属性 | 4.7.21 | ||
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 4.7.21 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 4.7.21 |
示例
{
"inventories": [
{
"uuid": "f0ef8d847b573c6b86565e1d9111723b",
"version": "v3",
"userName": "cloud",
"authAlgorithm": "SHA512",
"authPassword": "auth_password",
"privacyAlgorithm": "DES",
"privacyPassword": "priv_password",
"port": 161,
"status": "Enable",
"securityLevel": "authPriv"
}
]
}SNS SNMP平台清单 (SNS SNMP Platform Inventory)
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| snmpAddress | SNMP服务器地址 | 4.7.21 | ||
| snmpPort | SNMP服务器端口 | 4.7.21 | ||
| name | 请参见 资源属性 | 4.7.21 | ||
| description | 请参见 资源属性 | 4.7.21 | ||
| uuid | 请参见 资源属性 | 4.7.21 | ||
| tagUuids | 标签UUID列表 | 4.7.21 | ||
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 4.7.21 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 4.7.21 | ||
| createDate | 请参见 资源属性 | 4.7.21 | ||
| lastOpDate | 请参见 资源属性 | 4.7.21 |
操作(Operations)
创建SNMP代理(CreateSnmpAgent)
用户可以使用CreateSnmpAgent创建SNMP代理。例如：
CreateSnmpAgent version=v2c readcommunity=test port=1161参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| version | SNMP代理使用协议版本 | 4.7.21 | ||
| readCommunity | 读团体字(version为v2c时使用) | 是 | 4.7.21 | |
| userName | 用户名(version为v3时使用) | 是 | 4.7.21 | |
| authAlgorithm | 认证算法 | 是 | 4.7.21 | |
| authPassword | 认证密码 | 是 |
|
4.7.21 |
| privacyAlgorithm | 隐私算法 | 是 | 4.7.21 | |
| privacyPassword | 隐私密码 | 是 | 4.7.21 | |
| port | 端口 | 4.7.21 | ||
| resourceUuid | 资源UUID | 是 | 4.7.21 | |
| tagUuids | 标签UUID列表 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| timeout | 是 |
查询SNMP代理(QuerySnmpAgent)
用户可以使用QuerySnmpAgent查询SNMP代理。例如：
QuerySnmpAgent uuid=f0ef8d847b573c6b86565e1d9111723b原生域查询（Primitive Fields of Query）
更新SNMP代理(UpdateSnmpAgent)
用户可以使用UpdateSnmpAgent更新SNMP代理。例如：
UpdateSnmpAgent uuid=f0ef8d847b573c6b86565e1d9111723b version=v2c readcommunity=test port=1161参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| version | SNMP代理使用协议版本 | 4.7.21 | ||
| uuid | 资源的UUID，唯一标示该资源 | 4.7.21 | ||
| readCommunity | 读团体字(version为v2c时使用) | 是 | 4.7.21 | |
| userName | 用户名(version为v3时使用) | 是 | 4.7.21 | |
| authAlgorithm | 认证算法 | 是 | 4.7.21 | |
| authPassword | 认证密码 | 是 |
|
4.7.21 |
| privacyAlgorithm | 隐私算法 | 是 | 4.7.21 | |
| privacyPassword | 隐私密码 | 是 | 4.7.21 | |
| port | 端口 | 4.7.21 | ||
| resourceUuid | 资源UUID | 是 | 4.7.21 | |
| tagUuids | 标签UUID列表 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| timeout | 是 |
创建SNMP Trap接收端通知对象(CreateSNSSnmpEndpoint)
用户可以使用CreateSNSSnmpEndpoint创建SNMP
Trap接收端通知对象。例如：
CreateSNSSnmpEndpoint name=test platformUuid=d71f754a80663dc7a6a2003cc5667846参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 资源名称 | 4.7.21 | ||
| description | 资源的详细描述 | 是 | 4.7.21 | |
| platformUuid | SNMP平台UUID | 是 | 4.7.21 | |
| resourceUuid | 资源UUID | 是 | 4.7.21 | |
| tagUuids | 标签UUID列表 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| timeout | 是 |
发送SNMP测试消息(SNSSnmpTestConnection)
用户可以使用SNSSnmpTestConnection向SNMP
Trap接收端通知对象发送测试消息。例如：
SNSSnmpTestConnection platformUuid=d71f754a80663dc7a6a2003cc5667846 endpointUuid=e3a38d5d8d123991bd0a986150f3e6df参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| platformUuid | SNMP平台UUID | 是 | 5.1.8 | |
| endpointUuid | SNMP Trap接收端通知对象UUID | 是 | 5.1.8 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 5.1.8 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 5.1.8 | |
| timeout | 是 |
创建SNS SNMP平台(CreateSNSSnmpPlatform)
用户可以使用CreateSNSSnmpPlatform创建SNMP平台。例如：
CreateSNSSnmpPlatform snmpAddress=127.0.0.1 snmpPort=161 name=test参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| snmpAddress | SNMP服务器地址 | 4.7.21 | ||
| snmpPort | SNMP服务器端口 | 4.7.21 | ||
| name | 资源名称 | 4.7.21 | ||
| description | 资源的详细描述 | 是 | 4.7.21 | |
| resourceUuid | 资源UUID | 是 | 4.7.21 | |
| tagUuids | 标签UUID列表 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| timeout | 是 |
查询SNS SNMP平台信息(QuerySNSSnmpPlatform)
用户可以使用QuerySNSSnmpPlatform查询SNMP平台。例如：
QuerySNSSnmpPlatform原生域查询（Primitive Fields of Query）
嵌套和扩展域查询（Nested And Expanded Fields of Query）
| 域（Field） | 清单（Inventory） | 描述 | 起始支持版本 |
|---|---|---|---|
| endpoints | endpoints inventory | 4.7.21 |
更新SNS SNMP平台信息(UpdateSNSSnmpPlatform)
用户可以使用UpdateSNSSnmpPlatform更新SNMP平台。例如：
UpdateSNSSnmpPlatform snmpAddress=127.0.0.1 snmpPort=161 name=test uuid=38c619bf4e7a4cdaa04fcb44d85d5fc9| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| snmpAddress | SNMP服务器地址 | 4.7.21 | ||
| snmpPort | SNMP服务器端口 | 4.7.21 | ||
| uuid | 资源的UUID，唯一标示该资源 | 4.7.21 | ||
| name | 资源名称 | 是 | 4.7.21 | |
| description | 资源的详细描述 | 是 | 4.7.21 | |
| resourceUuid | 资源UUID | 是 | 4.7.21 | |
| tagUuids | 标签UUID列表 | 是 | 4.7.21 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag) | 是 | 4.7.21 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag) | 是 | 4.7.21 | |
| timeout | 是 |
标签
用户可以使用CreateUserTag resourceType=LdapServerVO创建用户标签。
例如：
CreateUserTag resourceType=LdapServerVO tag=Test1 \
resourceUuid=3214e0dcd01d4e2aa8407968e1ccreatee51d58