No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

RESTful API Reference

CloudEngine 8800, 7800, 6800, and 5800 V200R002C50

This document describes the OPS APIs supported by the device, including OPS-supported operations, request examples, elements in the requests, response examples, elements in the responses, and response status codes.
Rate and give feedback :
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
SNMP Blacklist Feature

SNMP Blacklist Feature

Configure the SNMP Blacklist Feature

Operation

URI

Description

PUT

/snmp/blackListCfg

Configure the SNMP blacklist feature.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <blackListCfg>
        <blockIpEnable>false</blockIpEnable>
        <blockUserEnable>false</blockUserEnable>
        <blockUserFailureCount>2</blockUserFailureCount>
        <blockUserPeriod>2</blockUserPeriod>
        <blockUserReactiveTime>5</blockUserReactiveTime>
    </blackListCfg>

    Table 3-316 describes elements in requests.

    Table 3-316  Elements

    Element

    Description

    blockIpEnable

    Specifies whether to enable the blacklist function for IP addresses.

    blockUserEnable

    Specifies whether to enable the blacklist function for users.

    blockUserFailureCount

    Specifies the maximum number of consecutive authentication failures allowed for an SNMPv3 user.

    blockUserPeriod

    Specifies a period after which a user is locked due to consecutive login failures.

    blockUserReactiveTime

    Specifies the locking period of an SNMPv3 user if the number of the user's authentication failures exceeds a specified value. By default, an SNMPv3 user is locked for 5 minutes.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <ok/>

    Table 3-317 describes status codes in responses.

    Table 3-317  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Obtain SNMP Blacklist Configurations

Operation

URI

Description

GET

/snmp/blackListCfg

Obtain SNMP blacklist configurations.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <blackListCfg>
        <blockIpEnable></blockIpEnable>
        <blockUserEnable></blockUserEnable>
        <blockUserFailureCount></blockUserFailureCount>
        <blockUserPeriod></blockUserPeriod>
        <blockUserReactiveTime></blockUserReactiveTime>
    </blackListCfg>

    Table 3-318 describes elements in requests.

    Table 3-318  Elements

    Element

    Description

    blockIpEnable

    Specifies whether the blacklist function for IP addresses is enabled.

    blockUserEnable

    Specifies whether the blacklist function for users is enabled.

    blockUserFailureCount

    Specifies the maximum number of consecutive authentication failures allowed for an SNMPv3 user.

    blockUserPeriod

    Specifies a period after which a user is locked due to consecutive login failures.

    blockUserReactiveTime

    Specifies the locking period of an SNMPv3 user if the number of the user's authentication failures exceeds a specified value. By default, an SNMPv3 user is locked for 5 minutes.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <blackListCfg>
        <blockIpEnable>false</blockIpEnable>
        <blockUserEnable>false</blockUserEnable>
        <blockUserFailureCount>2</blockUserFailureCount>
        <blockUserPeriod>2</blockUserPeriod>
        <blockUserReactiveTime>5</blockUserReactiveTime>
    </blackListCfg>

    Table 3-319 describes elements in responses.

    Table 3-319  Elements

    Element

    Description

    blockIpEnable

    Specifies whether the blacklist function for IP addresses is enabled.

    blockUserEnable

    Specifies whether the blacklist function for users is enabled.

    blockUserFailureCount

    Specifies the maximum number of consecutive authentication failures allowed for an SNMPv3 user.

    blockUserPeriod

    Specifies a period after which a user is locked due to consecutive login failures.

    blockUserReactiveTime

    Specifies the locking period of an SNMPv3 user if the number of the user's authentication failures exceeds a specified value. By default, an SNMPv3 user is locked for 5 minutes.

    Table 3-320 describes status codes in responses.

    Table 3-320  Status codes

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 22443

Downloads: 118

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next