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).
HWTACACS Server Template Configuration

HWTACACS Server Template Configuration

Create HWTACACS Server Templates

Operation

URI

Description

POST

/hwtacacs/hwTacTempCfgs/hwTacTempCfg

Create HWTACACS server templates.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacTempCfg>
        <templateName>htipl</templateName>
        <isDomainInclude>true</isDomainInclude>
        <responseTimeout>3</responseTimeout>
        <quietTime>10</quietTime>
        <sharedKey> Huawei-13579</sharedKey>
        <sourceIpAddress>10.1.1.1</sourceIpAddress> 
    </hwTacTempCfg>

    Table 3-807 describes elements in requests.

    Table 3-807  Elements

    Element

    Description

    templateName

    Specifies the name of an HWTACACS server template.

    isDomainInclude

    Specifies whether to carry the domain name in a user name.

    responseTimeout

    Specifies a response timeout period. The value ranges from 1 to 300, in seconds.

    quietTime

    Specifies a quiet timeout period. The value ranges from 1 to 255, in minutes.

    sharedKey

    Specifies a shared key. The value is a string of case-sensitive characters that can be letters or digits. The password can be a string of 1 to 255 characters in plain text or a string of 20 to 392 characters in encrypted text.

    sourceIpAddress

    Specifies the source IP address.

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

    Table 3-808 describes status codes in responses.

    Table 3-808  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.

Query HWTACACS Server Template Configurations

Operation

URI

Description

GET

/hwtacacs/hwTacTempCfgs/hwTacTempCfg

Query HWTACACS server template configurations.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacTempCfg>
        <templateName/>
        <isDomainInclude/>
        <responseTimeout/>
        <quietTime/>
        <sharedKey/>
        <sourceIpAddress/>
        <priAuthenSrv/>
        <priAuthenPort/>
        <curAuthenSrv/>
        <secAuthenSrvNo/>
        <curAuthenPort/>
        <authenSrvOpenNo/>
        <authenSrvClseNo/>
        <authenReqNo/>
        <authenRspNo/>
        <authenUnknownNo/>
        <authenTimeoutNo/>
        <authenPktDropNo/>
        <authenLoginNo/>
        <authenSendNo/>
        <authenSndPassNo/>
        <authenAbortNo/>
        <authenConnectNo/>
        <authenRspErrNo/>
        <authenRspFailNo/>
        <authenFollowNo/>
        <authenGetdataNo/>
        <authenGetpassNo/>
        <authenGetusrNo/>
        <authenRspPassNo/>
        <authenRestartNo/>
        <authenPndreqNo/>
        <authenRndTrpTim/>
        <authenMalformNo/>           
    </hwTacTempCfg>

    Table 3-809 describes elements in requests.

    Table 3-809  Elements

    Element

    Description

    templateName

    Specifies the name of an HWTACACS server template.

    isDomainInclude

    Specifies whether to carry the domain name in a user name.

    responseTimeout

    Specifies a response timeout period. The value ranges from 1 to 300, in seconds.

    quietTime

    Specifies a quiet timeout period. The value ranges from 1 to 255, in minutes.

    sharedKey

    Specifies a shared key. The value is a string of case-sensitive characters that can be letters or digits. The password can be a string of 1 to 255 characters in plain text or a string of 20 to 392 characters in encrypted text.

    sourceIpAddress

    Specifies the source IP address.

    priAuthenSrv

    Specifies the primary authentication server.

    priAuthenPort

    Specifies the primary authentication port.

    curAuthenSrv

    Specifies the current authentication server.

    secAuthenSrvNo

    Specifies the number of secondary authentication servers configured.

    curAuthenPort

    Specifies the current authentication port.

    authenSrvOpenNo

    Specifies the number of started authentication servers.

    authenSrvClseNo

    Specifies the number of stopped authentication servers.

    authenReqNo

    Specifies the number of authentication request packets.

    authenRspNo

    Specifies the number of authentication response packets.

    authenUnknownNo

    Specifies the number of unknown authentication packets.

    authenTimeoutNo

    Specifies an authentication timeout interval, in seconds.

    authenPktDropNo

    Specifies the number of authentication packets dropped.

    authenLoginNo

    Specifies the number of authentication login attempts.

    authenSendNo

    Specifies the number of authentication sending times.

    authenSndPassNo

    Specifies the number of times authentication is passed.

    authenAbortNo

    Specifies the number of times authentication is aborted.

    authenConnectNo

    Specifies the number of authentication connections.

    authenRspErrNo

    Specifies the number of authentication response errors.

    authenRspFailNo

    Specifies the number of authentication response failures.

    authenFollowNo

    Specifies the number of consecutive authentication responses.

    authenGetdataNo

    Specifies the authentication query data count.

    authenGetpassNo

    Specifies the number of authentication query passing times.

    authenGetusrNo

    Specifies the number of authentication query users.

    authenRspPassNo

    Specifies the number of authentication response passing times.

    authenRestartNo

    Specifies the number of authentication restarts.

    authenPndreqN

    Specifies the number of authentication pending requests.

    authenRndTrpTim

    Specifies the authentication round trip count.

    authenMalformNo

    Specifies the number of malformed authentication packets.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacTempCfg>
        <templateName>htipl</templateName>
        <isDomainInclude>true</isDomainInclude>
        <responseTimeout>5</responseTimeout>
        <responseTimeout>3</responseTimeout>
        <quietTime>5</quietTime>
        <sourceIpAddress>10.1.1.1</sourceIpAddress>
        <curAuthenSrv>0.0.0.0</curAuthenSrv>
        <curAuthenPort>0</curAuthenPort>
        <secAuthenSrvNo>0</secAuthenSrvNo>
        <priAuthenSrv>0.0.0.0</priAuthenSrv>
        <priAuthenPort>0</priAuthenPort>
        <authenSndPassNo>0</authenSndPassNo>
        <authenFollowNo>0</authenFollowNo>
        <authenSrvOpenNo>0</authenSrvOpenNo>
        <authenRspNo>0</authenRspNo>
        <authenUnknownNo>0</authenUnknownNo>
        <authenRspErrNo>0</authenRspErrNo>
        <authenRspPassNo>0</authenRspPassNo>
        <authenGetusrNo>0</authenGetusrNo>
        <authenGetdataNo>0</authenGetdataNo>
        <authenSrvClseNo>0</authenSrvClseNo>
        <authenRspFailNo>0</authenRspFailNo>
        <authenTimeoutNo>0</authenTimeoutNo>
        <authenPndreqNo>0</authenPndreqNo>
        <authenMalformNo>0</authenMalformNo>
        <authenRndTrpTim>0</authenRndTrpTim>
        <authenPktDropNo>0</authenPktDropNo>
        <authenAbortNo>0</authenAbortNo>
        <authenConnectNo>0</authenConnectNo>
        <authenSendNo>0</authenSendNo>
        <authenLoginNo>0</authenLoginNo>
        <authenReqNo>0</authenReqNo>
        <authenRestartNo>0</authenRestartNo>
        <authenGetpassNo>0</authenGetpassNo>        
    </hwTacTempCfg>

    Table 3-810 describes elements in responses.

    Table 3-810  Elements

    Element

    Description

    templateName

    Specifies the name of an HWTACACS server template.

    isDomainInclude

    Specifies whether to carry the domain name in a user name.

    responseTimeout

    Specifies a response timeout period. The value ranges from 1 to 300, in seconds.

    quietTime

    Specifies a quiet timeout period. The value ranges from 1 to 255, in minutes.

    sharedKey

    Specifies a shared key. The value is a string of case-sensitive characters that can be letters or digits. The password can be a string of 1 to 255 characters in plain text or a string of 20 to 392 characters in encrypted text.

    sourceIpAddress

    Specifies the source IP address.

    priAuthenSrv

    Specifies the primary authentication server.

    priAuthenPort

    Specifies the primary authentication port.

    curAuthenSrv

    Specifies the current authentication server.

    secAuthenSrvNo

    Specifies the number of secondary authentication servers configured.

    curAuthenPort

    Specifies the current authentication port.

    authenSrvOpenNo

    Specifies the number of started authentication servers.

    authenSrvClseNo

    Specifies the number of stopped authentication servers.

    authenReqNo

    Specifies the number of authentication request packets.

    authenRspNo

    Specifies the number of authentication response packets.

    authenUnknownNo

    Specifies the number of unknown authentication packets.

    authenTimeoutNo

    Specifies an authentication timeout interval, in seconds.

    authenPktDropNo

    Specifies the number of authentication packets dropped.

    authenLoginNo

    Specifies the number of authentication login attempts.

    authenSendNo

    Specifies the number of authentication sending times.

    authenSndPassNo

    Specifies the number of times authentication is passed.

    authenAbortNo

    Specifies the number of times authentication is aborted.

    authenConnectNo

    Specifies the number of authentication connections.

    authenRspErrNo

    Specifies the number of authentication response errors.

    authenRspFailNo

    Specifies the number of authentication response failures.

    authenFollowNo

    Specifies the number of consecutive authentication responses.

    authenGetdataNo

    Specifies the authentication query data count.

    authenGetpassNo

    Specifies the number of authentication query passing times.

    authenGetusrNo

    Specifies the number of authentication query users.

    authenRspPassNo

    Specifies the number of authentication response passing times.

    authenRestartNo

    Specifies the number of authentication restarts.

    authenPndreqN

    Specifies the number of authentication pending requests.

    authenRndTrpTim

    Specifies the authentication round trip count.

    authenMalformNo

    Specifies the number of malformed authentication packets.

    Table 3-811 describes status codes in responses.

    Table 3-811  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.

Modify HWTACACS Server Templates

Operation

URI

Description

PUT

/hwtacacs/hwTacTempCfgs/hwTacTempCfg

Modify HWTACACS server templates.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacTempCfg>
        <templateName>htipl</templateName>
        <isDomainInclude>true</isDomainInclude>
        <responseTimeout>3</responseTimeout>
        <quietTime>10</quietTime>
        <sharedKey>Huawei-12345</sharedKey>
        <sourceIpAddress>10.1.1.1</sourceIpAddress>     
    </hwTacTempCfg>

    Table 3-812 describes elements in requests.

    Table 3-812  Elements

    Element

    Description

    templateName

    Specifies the name of an HWTACACS server template. (Mandatory)

    isDomainInclude

    Specifies whether to carry the domain name in a user name.

    responseTimeout

    Specifies a response timeout period. The value ranges from 1 to 300, in seconds.

    quietTime

    Specifies a quiet timeout period. The value ranges from 1 to 255, in minutes.

    sharedKey

    Specifies a shared key. The value is a string of case-sensitive characters that can be letters or digits. The password can be a string of 1 to 255 characters in plain text or a string of 20 to 392 characters in encrypted text.

    sourceIpAddress

    Specifies the source IP address.

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

    Table 3-813 describes status codes in responses.

    Table 3-813  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.

Delete HWTACACS Server Templates

Operation

URI

Description

DELETE

/hwtacacs/hwTacTempCfgs/hwTacTempCfg

Delete configured HWTACACS server templates.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacTempCfg>
        <templateName>htipl3</templateName>  
    </hwTacTempCfg>

    Table 3-814 describes elements in requests.

    Table 3-814  Elements

    Element

    Description

    templateName

    Specifies the name of an HWTACACS server template.

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

    Table 3-815 describes status codes in responses.

    Table 3-815  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: 30635

Downloads: 127

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