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 12800 and 12800E V200R005C10

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).
Query SSH Client Information

Query SSH Client Information

Operation

URI

Description

GET

/sshc/sshClient

Query SSH client information.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <sshClient>
        <keepAliveTime/>
        <keepAliveCount/>
        <firstTimeEnable/> 
        <SrcInterface/>
        <SrcIpv4Addr/>
        <vpnInstanceName/>
        <scpSrcInterface/>
        <scpSrcIpv4Addr/>
        <scpVpnInstanceName/>
    </sshClient>

    Table 13-3 describes elements in requests.

    Table 13-3 Elements

    Element

    Description

    keepAliveTime

    Specifies an interval at which the client sends Keepalive packets to the server.

    The default value is 0s, indicating that the client does not send any Keepalive packet to the server.

    If a client does not receive any response packet from the server within a specified interval, the client sends a new Keepalive packet to the server. If the server still does not respond, the client disconnects from the server.

    keepAliveCount

    Specifies the maximum number of Keepalive packets that a client can send to the server.

    The default value is 3, indicating that a client can send a maximum of three Keepalive packets to the server before disconnection.

    firstTimeEnable

    Enables or disables first-time authentication for the SSH client. If this function is enabled, the system automatically allocates the RSA, DSA, or ECC public key after the first-time login and stores the key for later logins.

    SrcInterface

    Specifies a loopback interface of the local router. An SFTP client uses this interface as the local interface.

    SrcIpv4Addr

    Specifies the source address of the local router. An SFTP client uses this address as the local address.

    vpnInstanceName

    Specifies the name of the VPN instance to which the SFTP client belongs.

    scpSrcInterface

    Specifies a loopback interface of the local router. An SCP client uses this interface as the local interface.

    scpSrcIpv4Addr

    Specifies the loopback address of the local router.

    vpnInstanceName

    Specifies the name of the VPN instance to which the SCP server belongs.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <sshClient>
        <keepAliveTime>3</keepAliveTime>
        <keepAliveCount>3</keepAliveCount>
        <firstTimeEnable>Enable</firstTimeEnable>
        <SrcIpv4Addr>1.1.1.1</SrcIpv4Addr>
        <SrcInterface></SrcInterface>>
        <vpnInstanceName>vpn-1</vpnInstanceName>
        <scpSrcIpv4Addr>1.1.1.1</scpSrcIpv4Addr>
        <scpSrcInterface></scpSrcInterface>
        <scpVpnInstanceName>vpn-1</scpVpnInstanceName>
    </sshClient>

    Table 13-4 describes elements in responses.

    Table 13-4 Elements

    Element

    Description

    keepAliveTime

    Specifies an interval at which the client sends Keepalive packets to the server.

    The default value is 0s, indicating that the client does not send any Keepalive packet to the server.

    If a client does not receive any response packet from the server within a specified interval, the client sends a new Keepalive packet to the server. If the server still does not respond, the client disconnects from the server.

    keepAliveCount

    Specifies the maximum number of Keepalive packets that a client can send to the server.

    The default value is 3, indicating that a client can send a maximum of three Keepalive packets to the server before disconnection.

    firstTimeEnable

    Enables or disables first-time authentication for the SSH client. If this function is enabled, the system automatically allocates the RSA, DSA, or ECC public key after the first-time login and stores the key for later logins.

    SrcInterface

    Specifies a loopback interface of the local router. An SFTP client uses this interface as the local interface.

    SrcIpv4Addr

    Specifies the source address of the local router. An SFTP client uses this address as the local address.

    vpnInstanceName

    Specifies the name of the VPN instance to which the SFTP client belongs.

    scpSrcInterface

    Specifies a loopback interface of the local router. An SCP client uses this interface as the local interface.

    scpSrcIpv4Addr

    Specifies the loopback address of the local router.

    vpnInstanceName

    Specifies the name of the VPN instance to which the SCP server belongs.

Translation
Download
Updated: 2019-04-03

Document ID: EDOC1100075372

Views: 10692

Downloads: 16

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