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 Server Information

Query SSH Server Information

Operation

URI

Description

GET

/sshs/sshServer

Query SSH server information.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <sshServer>
        <portNumber/>
        <sshacl4Num/>
        <sshacl4Name/> 
        <sshacl6Num/>
        <sshacl6Name/>
        <authenticationTimeout/>
        <rekeyInterval/>
        <keepAliveEnable/>
        <compatibleSsh1x/>
        <sshVersion/>
        <stelnetEnable/>
        <sftpEnable/>
        <sftpMaxUser/>
        <sftpTimeoutMin/>
        <sftpTimeoutSec/>
        <snetconfEnable/>
        <sshAuthDefPass/>
        <authRetries/>
        <sftpOnlineUser/>
        <scpEnable/>
        <scpMaxsession/>
        <snetconfPortEnable/>
        <desEnable/>
        <rsaHostKey/>
        <rsaServerKey/>
        <dsaHostKey/>
        <eccHostKey/>       
    </sshServer>

    Table 13-27 describes elements in requests.

    Table 13-27 Elements

    Element

    Description

    portNumber

    Specifies the number of the port that the SSH server monitors. The port number can be either 22 or an integer ranging from 1025 to 65535.

    sshacl4Num

    Specifies an ACL number for IPv4 protocols. The value is an integer ranging from 2000 to 3999.

    sshacl4Name

    Specifies an ACL name for IPv4 protocols. The value is a string of 1 to 32 characters.

    sshacl6Num

    Specifies an ACL number for IPv6 protocols. The value is an integer ranging from 2000 to 3999.

    sshacl6Name

    Specifies an ACL name for IPv6 protocols. The value is a string of 1 to 32 characters.

    authenticationTimeout

    Specifies the timeout period of an SSH connection. The value ranges between 1 to 120 seconds.

    rekeyInterval

    Specifies an interval at which the key pair of the SSH server is updated. The value ranges between 0 to 24 hours.

    keepAliveEnable

    Specifies whether the keepalive feature is enabled on the SSH server.

    compatibleSsh1x

    Specifies the status of the version-compatible function on the SSH server.

    sshVersion

    Specifies an SSH version, which can be 1.9 or 2.

    stelnetEnable

    Specifies whether the STelnet service is enabled on the SSH server.

    sftpEnable

    Specifies whether the SFTP service is enabled on the SSH server.

    sftpMaxUser

    Specifies the maximum number of sessions for SFTP.

    sftpTimeoutMin

    Specifies a timeout period, in minutes. The value ranges from 0 to 35791 minutes.

    sftpTimeoutSec

    Specifies a timeout period, in seconds. The value ranges from 0 to 59 seconds.

    snetconfEnable

    Specifies whether the SNETCONF service is enabled on the SSH server.

    sshAuthDefPass

    Specifies password authentication as the default authentication mode for SSH users.

    authRetries

    Specifies the number of retries to authenticate an SSH connection.

    sftpOnlineUser

    Specifies the current number of online SFTP users.

    scpEnable

    Specifies whether the SCP service is enabled on the SSH server.

    scpMaxsession

    Specifies the maximum number of SCP clients that can be connected to the SSH server.

    snetconfPortEnable

    Specifies whether a NETCONF connection is established on the well-known port 830.

    desEnable

    Specifies whether the DES encryption algorithm is enabled on the SSH server.

    rsaHostKey

    Specifies an RSA host key as the key assigned to the SSH server.

    rsaServerKey

    Specifies an RSA server key as the key assigned to the SSH server.

    dsaHostKey

    Specifies a DSA host key as the key assigned to the SSH server.

    eccHostKey

    Specifies an ECC host key as the key assigned to the SSH server.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <sshServer>
        <portNumber>22</portNumber>
        <sshacl4Name></sshacl4Name>
        <sshacl4Num/>
        <sshacl6Name></sshacl6Name>
        <sshacl6Num/>
        <authenticationTimeout>90</authenticationTimeout>
        <rekeyInterval>2</rekeyInterval>
        <keepAliveEnable>Enable</keepAliveEnable>
        <compatibleSsh1x>Disable</compatibleSsh1x>
        <sshVersion>sshVer2</sshVersion>
        <stelnetEnable>Enable</stelnetEnable>
        <sftpEnable>Enable</sftpEnable>
        <sftpMaxUser>10</sftpMaxUser>
        <sftpTimeoutMin>1</sftpTimeoutMin>
        <sftpTimeoutSec>30</sftpTimeoutSec>
        <snetconfEnable>Enable</snetconfEnable>
        <sshAuthDefPass>Disable</sshAuthDefPass>          
        <authRetries>4</authRetries>
        <sshVersion>sshVer1_99</sshVersion>
        <rekeyInterval>2</rekeyInterval>
        <authenticationTimeout>90</authenticationTimeout>
        <portNumber>22</portNumber>
        <keepAliveEnable>Enable</keepAliveEnable>
        <compatibleSsh1x>Enable</compatibleSsh1x>
        <stelnetEnable>Enable</stelnetEnable>
        <sftpEnable>Enable</sftpEnable>
        <sftpMaxUser>10</sftpMaxUser>
        <sftpTimeoutMin>1</sftpTimeoutMin>
        <sftpTimeoutSec>30</sftpTimeoutSec>
        <snetconfEnable>Enable</snetconfEnable>
        <sshAuthDefPass>Enable</sshAuthDefPass>
        <authRetries>4</authRetries>
        <sshacl4Name></sshacl4Name>
        <sshacl4Num/>
        <sshacl6Name></sshacl6Name>
        <sshacl6Num/>
        <snetconfPortEnable>Enable</snetconfPortEnable>
        <srcInterfName></srcInterfName>
        <desEnable>Enable</desEnable>
        <scpEnable>Enable</scpEnable>
        <scpMaxsession>5</scpMaxsession>
        <rsaHostKey></rsaHostKey>
        <rsaServerKey></rsaServerKey>
        <dsaHostKey></dsaHostKey>
        <eccHostKey></eccHostKey>
        <scpEnable>Disable</scpEnable>
        <scpMaxsession>5</scpMaxsession>
        <snetconfPortEnable>Disable</snetconfPortEnable>
        <desEnable>Disable</desEnable>
        <rsaHostKey></rsaHostKey>
        <rsaServerKey></rsaServerKey>
        <dsaHostKey></dsaHostKey>
        <eccHostKey></eccHostKey>     
    </sshServer>

    Table 13-28 describes elements in responses.

    Table 13-28 Elements

    Element

    Description

    portNumber

    Specifies the number of the port that the SSH server monitors. The port number can be either 22 or an integer ranging from 1025 to 65535.

    sshacl4Num

    Specifies an ACL number for IPv4 protocols. The value is an integer ranging from 2000 to 3999.

    sshacl4Name

    Specifies an ACL name for IPv4 protocols. The value is a string of 1 to 32 characters.

    sshacl6Num

    Specifies an ACL number for IPv6 protocols. The value is an integer ranging from 2000 to 3999.

    sshacl6Name

    Specifies an ACL name for IPv6 protocols. The value is a string of 1 to 32 characters.

    authenticationTimeout

    Specifies the timeout period of an SSH connection. The value ranges between 1 to 120 seconds.

    rekeyInterval

    Specifies an interval at which the key pair of the SSH server is updated. The value ranges between 0 to 24 hours.

    keepAliveEnable

    Specifies whether the keepalive feature is enabled on the SSH server.

    compatibleSsh1x

    Specifies the status of the version-compatible function on the SSH server.

    sshVersion

    Specifies an SSH version, which can be 1.9 or 2.

    stelnetEnable

    Specifies whether the STelnet service is enabled on the SSH server.

    sftpEnable

    Specifies whether the SFTP service is enabled on the SSH server.

    sftpMaxUser

    Specifies the maximum number of sessions for SFTP.

    sftpTimeoutMin

    Specifies a timeout period, in minutes. The value ranges from 0 to 35791 minutes.

    sftpTimeoutSec

    Specifies a timeout period, in seconds. The value ranges from 0 to 59 seconds.

    snetconfEnable

    Specifies whether the SNETCONF service is enabled on the SSH server.

    sshAuthDefPass

    Specifies password authentication as the default authentication mode for SSH users.

    authRetries

    Specifies the number of retries to authenticate an SSH connection.

    sftpOnlineUser

    Specifies the current number of online SFTP users.

    scpEnable

    Specifies whether the SCP service is enabled on the SSH server.

    scpMaxsession

    Specifies the maximum number of SCP clients that can be connected to the SSH server.

    snetconfPortEnable

    Specifies whether a NETCONF connection is established on the well-known port 830.

    desEnable

    Specifies whether the DES encryption algorithm is enabled on the SSH server.

    rsaHostKey

    Specifies an RSA host key as the key assigned to the SSH server.

    rsaServerKey

    Specifies an RSA server key as the key assigned to the SSH server.

    dsaHostKey

    Specifies a DSA host key as the key assigned to the SSH server.

    eccHostKey

    Specifies an ECC host key as the key assigned to the SSH server.

Translation
Download
Updated: 2019-04-03

Document ID: EDOC1100075372

Views: 10756

Downloads: 16

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