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 Configuration

HWTACACS Server Configuration

Create HWTACACS Server Objects

Operation

URI

Description

POST

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacSrvCfgs/hwTacSrvCfg

Create HWTACACS server objects.

NOTE:

Server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacSrvCfg>
        <serverIpAddress> 10.1.1.2</serverIpAddress>
        <serverPort>1010</serverPort>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <isMuxModeEnable>true</isMuxModeEnable>
        <sharedKey>keyabc</sharedKey>
        <vpnName>abcd</vpnName>
        <isPublicNet>false</isPublicNet>         
    </hwTacSrvCfg>

    Table 3-816 describes elements in requests.

    Table 3-816  Elements

    Element

    Description

    serverIpAddress

    Specifies the IP address of a server. (Mandatory)

    serverPort

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

    serverType

    Specifies the server type. (Mandatory)

    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-817 describes status codes in responses.

    Table 3-817  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 Configurations

Operation

URI

Description

GET

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacSrvCfgs/hwTacSrvCfg

Query HWTACACS server configurations.

NOTE:

Server objects must be managed based on the corresponding template object.

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

    Table 3-818 describes elements in requests.

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

    isPublicNet

    Specifies whether to connect to the public network.

    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.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacSrvCfg>
        <serverIpAddress>10.1.1.2</serverIpAddress>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <serverPort>1010</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>
        <isPublicNet>false</isPublicNet>        
    </hwTacSrvCfg>

    Table 3-819 describes elements in responses.

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

    isPublicNet

    Specifies whether to connect to the public network.

    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.

    Table 3-820 describes status codes in responses.

    Table 3-820  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 Objects

Operation

URI

Description

PUT

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacSrvCfgs/hwTacSrvCfg

Modify HWTACACS server objects.

NOTE:

Server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacSrvCfg>
        <serverIpAddress> 10.1.1.2</serverIpAddress>
        <serverPort>1010</serverPort>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <isMuxModeEnable>true</isMuxModeEnable>
        <sharedKey>keyabc</sharedKey>
        <vpnName>abcd</vpnName>
        <isPublicNet>false</isPublicNet>           
    </hwTacSrvCfg>

    Table 3-821 describes elements in requests.

    Table 3-821  Elements

    Element

    Description

    serverIpAddress

    Specifies the IP address of a server. (Mandatory)

    serverPort

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

    serverType

    Specifies the server type. (Mandatory)

    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-822 describes status codes in responses.

    Table 3-822  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 Objects

Operation

URI

Description

DELETE

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacSrvCfgs/hwTacSrvCfg

Delete configured HWTACACS server objects.

NOTE:

Server objects must be managed based on the corresponding template object.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacSrvCfg>
        <serverIpAddress> 10.1.1.2</serverIpAddress>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <vpnName>_public_</vpnName>
        <isPublicNet>false</isPublicNet>         
    </hwTacSrvCfg>

    Table 3-823 describes elements in requests.

    Table 3-823  Elements

    Element

    Description

    serverIpAddress

    Specifies the IP address of a server.

    serverType

    Specifies the server type.

    isSecondaryServer

    Specifies whether the server is a secondary server.

    vpnName

    Specifies a VPN instance name.

    isPublicNet

    Specifies whether to connect to the public network.

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

    Table 3-824 describes status codes in responses.

    Table 3-824  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: 30272

Downloads: 127

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