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

HWTACACS IPv6 Server Configuration

Create HWTACACS IPv6 Server Objects

Operation

URI

Description

POST

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacIpv6SrvCfgs/hwTacIpv6SrvCfg

Create HWTACACS IPv6 server objects.

NOTE:

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

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacIpv6SrvCfg>
        <serverIpAddress> 2001:db8::1</serverIpAddress>
        <serverPort>1010</serverPort>
        <serverType>Authentication</serverType>
        <isSecondaryServer>false</isSecondaryServer>
        <isMuxModeEnable>true</isMuxModeEnable>
        <sharedKey>keyabc</sharedKey>
        <vpnName> abc</vpnName>         
    </hwTacIpv6SrvCfg>

    Table 3-825 describes elements in requests.

    Table 3-825  Elements

    Element

    Description

    serverIpAddress

    Specifies the IPv6 address of a server. (Mandatory)

    serverPort

    Specifies a server port.

    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 an IPv6 VPN instance name. The value is a string of 1 to 31 characters. (Mandatory)

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

    Table 3-826 describes status codes in responses.

    Table 3-826  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 IPv6 Server Configurations

Operation

URI

Description

GET

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacIpv6SrvCfgs/hwTacIpv6SrvCfg

Query HWTACACS IPv6 server configurations.

NOTE:

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

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

    Table 3-827 describes elements in requests.

    Table 3-827  Elements

    Element

    Description

    serverIpAddress

    Specifies the IPv6 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 an IPv6 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.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacIpv6SrvCfg>
        <serverIpAddress>2001:DB8::1</serverIpAddress>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <serverPort>49</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>abc</vpnName>
    </hwTacIpv6SrvCfg>
    <hwTacIpv6SrvCfg>
        <serverIpAddress>2001:DB8::3</serverIpAddress>
        <serverType>Authentication</serverType>
        <isSecondaryServer>true</isSecondaryServer>
        <serverPort>49</serverPort>
        <isMuxModeEnable>true</isMuxModeEnable>
        <serverCurrentState>Up</serverCurrentState>
        <isCurrentSrv>false</isCurrentSrv>
        <authenReqNo>0</authenReqNo>
        <authenRspNo>0</authenRspNo>
        <authenSrvOpenNo>0</authenSrvOpenNo>
        <authenSrvClseNo>0</authenSrvClseNo>
        <sharedKey></sharedKey>
        <vpnName>abc</vpnName>            
    </hwTacIpv6SrvCfg>

    Table 3-828 describes elements in responses.

    Table 3-828  Elements

    Element

    Description

    serverIpAddress

    Specifies the IPv6 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 an IPv6 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.

    Table 3-829 describes status codes in responses.

    Table 3-829  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 IPv6 Server Objects

Operation

URI

Description

PUT

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacIpv6SrvCfgs/hwTacIpv6SrvCfg

Modify HWTACACS IPv6 server objects.

NOTE:

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

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacIpv6SrvCfg operation="merge">
        <serverIpAddress>2001:db8::1</serverIpAddress>
        <serverPort>1010</serverPort>
        <serverType>Authentication</serverType>
        <isSecondaryServer>false</isSecondaryServer>
        <isMuxModeEnable>true</isMuxModeEnable>
        <sharedKey>keyabc</sharedKey>
        <vpnName> abc</vpnName>          
    </hwTacIpv6SrvCfg>

    Table 3-830 describes elements in requests.

    Table 3-830  Elements

    Element

    Description

    serverIpAddress

    Specifies the IPv6 address of a server. (Mandatory)

    serverPort

    Specifies a server port.

    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 an IPv6 VPN instance name. The value is a string of 1 to 31 characters. (Mandatory)

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

    Table 3-831 describes status codes in responses.

    Table 3-831  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 IPv6 Server Objects

Operation

URI

Description

DELETE

/hwtacacs/hwTacTempCfgs/hwTacTempCfg/hwTacIpv6SrvCfgs/hwTacIpv6SrvCfg

Delete configured HWTACACS IPv6 server objects.

NOTE:

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

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <hwTacIpv6SrvCfg>
        <serverIpAddress> 2001:db8::1</serverIpAddress>
        <serverType>Authentication</serverType>
        <isSecondaryServer>false</isSecondaryServer>
        <vpnName>abc</vpnName>          
    </hwTacIpv6SrvCfg>

    Table 3-832 describes elements in requests.

    Table 3-832  Elements

    Element

    Description

    serverIpAddress

    Specifies the IPv6 address of a server.

    serverType

    Specifies the server type.

    isSecondaryServer

    Specifies whether the server is a secondary server.

    vpnName

    Specifies an IPv6 VPN instance name.

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

    Table 3-833 describes status codes in responses.

    Table 3-833  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: 30288

Downloads: 127

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