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 Host Server Configuration

HWTACACS Host Server Configuration

Create HWTACACS Host Server Objects

Operation

URI

Description

POST

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/ hwTacHostSrvCfgs/hwTacHostSrvCfg

Create HWTACACS host server objects.

NOTE:

Host server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacHostSrvCfg>
        <serverHostName>host1</serverHostName>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <isPublicNet>true</isPublicNet>
        <isMuxModeEnable>true</isMuxModeEnable>
        <sharedKey>keyabc</sharedKey>
        <vpnName>_public_</vpnName>
        <serverPort>1025</serverPort>             
    </hwTacHostSrvCfg>

    Table 3-834 describes elements in requests.

    Table 3-834  Elements

    Element

    Description

    serverHostName

    Specifies the host name of a server. (Mandatory)

    serverType

    Specifies the server type: Authentication, Authorization, Accounting, and Common. (Mandatory)

    serverPort

    Specifies a server port. The value is an integer ranging from 1 to 65535.

    isSecondaryServer

    Specifies whether the server is a secondary server. (Mandatory)

    isMuxModeEnable

    Specifies whether to use the multiplexing mode.

    sharedKey

    Specifies a shared key.

    vpnName

    Specifies a VPN instance name. The value is a string of 1 to 31 characters. (Mandatory)

    isPublicNet

    Specifies whether to connect to the public network. (Mandatory)

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

    Table 3-835 describes status codes in responses.

    Table 3-835  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 Host Server Configurations

Operation

URI

Description

GET

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/ hwTacHostSrvCfgs/hwTacHostSrvCfg

Query HWTACACS host server configurations.

NOTE:

Host server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> >
    <hwTacHostSrvCfg>
        <serverPort/>
        <serverType/>
        <isSecondaryServer/>
        <isMuxModeEnable/>
        <serverCurrentState/>
        <isCurrentSrv/>
        <sharedKey/>
        <vpnName/>
        <authenSrvOpenNo/>
        <authenSrvClseNo/>
        <authenReqNo/>
        <authenRspNo/>
       <serverHostName/>            
    </hwTacHostSrvCfg>

    Table 3-836 describes elements in requests.

    Table 3-836  Elements

    Element

    Description

    serverIpAddress

    Specifies the IP address of a server.

    serverPort

    Specifies a server port.

    serverType

    Specifies the server type: Authentication, Authorization, Accounting, and Common.

    isSecondaryServer

    Specifies whether the server is a secondary server.

    isMuxModeEnable

    Specifies whether to use the multiplexing mode.

    serverCurrentState

    Specifies the current server status: Active, Down

    isCurrentSrv

    Specifies whether a server is the current server.

    sharedKey

    Specifies a shared key.

    vpnName

    Specifies a VPN instance name.

    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.

    serverHostName

    Specifies the host name of a server.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacHostSrvCfg>
        <serverHostName>host1</serverHostName>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <serverPort>1025</serverPort>
        <isMuxModeEnable>true</isMuxModeEnable>
        <serverCurrentState>Up</serverCurrentState>
        <isCurrentSrv>true</isCurrentSrv>
        <authenReqNo>0</authenReqNo>
        <authenRspNo>0</authenRspNo>
        <authenSrvOpenNo>0</authenSrvOpenNo>
        <authenSrvClseNo>0</authenSrvClseNo>
        <sharedKey></sharedKey>
        <vpnName>_public_</vpnName>   
    </hwTacHostSrvCfg>

    Table 3-837 describes elements in responses.

    Table 3-837  Elements

    Element

    Description

    serverIpAddress

    Specifies the IP address of a server.

    serverPort

    Specifies a server port.

    serverType

    Specifies the server type: Authentication, Authorization, Accounting, and Common.

    isSecondaryServer

    Specifies whether the server is a secondary server.

    isMuxModeEnable

    Specifies whether to use the multiplexing mode.

    serverCurrentState

    Specifies the current server status: Active, Down

    isCurrentSrv

    Specifies whether a server is the current server.

    sharedKey

    Specifies a shared key.

    vpnName

    Specifies a VPN instance name.

    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.

    serverHostName

    Specifies the host name of a server.

    Table 3-838 describes status codes in responses.

    Table 3-838  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 Host Server Objects

Operation

URI

Description

PUT

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/ hwTacHostSrvCfgs/hwTacHostSrvCfg

Modify HWTACACS host server objects.

NOTE:

Host server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacHostSrvCfg>
        <serverHostName>host1</serverHostName>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <isPublicNet>true</isPublicNet>
        <isMuxModeEnable>true</isMuxModeEnable>
        <sharedKey>keyabc</sharedKey>
        <vpnName>_public_</vpnName>
    <serverPort>1025</serverPort>            
    </hwTacHostSrvCfg>

    describes elements in requests.

    Table 3-839  Elements

    Element

    Description

    serverHostName

    Specifies the host name of a server. (Mandatory)

    serverType

    Specifies the server type: Authentication, Authorization, Accounting, and Common. (Mandatory)

    serverPort

    Specifies a server port. The value is an integer ranging from 1 to 65535.

    isSecondaryServer

    Specifies whether the server is a secondary server. (Mandatory)

    isMuxModeEnable

    Specifies whether to use the multiplexing mode.

    sharedKey

    Specifies a shared key.

    vpnName

    Specifies a VPN instance name. The value is a string of 1 to 31 characters. (Mandatory)

    isPublicNet

    Specifies whether to connect to the public network. (Mandatory)

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

    Table 3-840 describes status codes in responses.

    Table 3-840  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 Host Server Objects

Operation

URI

Description

DELETE

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/ hwTacHostSrvCfgs/hwTacHostSrvCfg

Delete configured HWTACACS host server objects.

NOTE:

Host server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacHostSrvCfg>
        <serverHostName>host1</serverHostName>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <isPublicNet>true</isPublicNet>
        <vpnName>_public_</vpnName>            
    </hwTacHostSrvCfg>

    Table 3-841 describes elements in requests.

    Table 3-841  Elements

    Element

    Description

    serverHostName

    Specifies the host name of a server.

    serverType

    Specifies the server type.

    isSecondaryServer

    Specifies whether the server is a secondary server.

    vpnName

    Specifies a VPN instance name.

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

    Table 3-842 describes status codes in responses.

    Table 3-842  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: 21235

Downloads: 116

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