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).
SSH User Management

SSH User Management

Create SSH Users

Operation

URI

Description

POST

/sshs/sshUserCfgs/sshUserCfg

Create SSH users.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?>
    <sshUserCfg>
        <userName> testuser </userName> 
        <authType>rsa</authType>
        <userName> testuser </userName>
        <sftpDir>cfcard:/ssh</sftpDir> 
        <userName> testuser </userName>
        <sshServiceType>sftp</sshServiceType> 
        <userName>test</userName>
        <authType>dsa</authType>
        <sftpDir></sftpDir>
        <keyName>dsa</keyName>
        <sshServiceType>all</sshServiceType>
        <pubKeyType>DSA</pubKeyType>   
    </sshUserCfg>

    Table 3-205 describes elements in requests.

    Table 3-205  Elements

    Element

    Description

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported. (Mandatory)

    authType

    Specifies an authentication type.

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    sftpDir

    Specifies the name of a directory on the SFTP server. The name is a string of 1 to 128 characters.

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    sshServiceType

    Specifies the service type of an SSH user.

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    pubKeyType

    Specifies the public key type of an SSH user.

    keyName

    Specifies the name of a configured public key.

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

    Table 3-206 describes status codes in responses.

    Table 3-206  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 SSH Users

Operation

URI

Description

GET

/sshs/sshUserCfgs/sshUserCfg

Query SSH users.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <sshUserCfg>
        <userName/>
        <authType/>            
        <sftpDir/>
        <sshServiceType/>
        <pubKeyType/>
        <keyName/>    
    </sshUserCfg>

    Table 3-207 describes elements in requests.

    Table 3-207  Elements

    Element

    Description

    userName

    Specifies the name of an SSH user.

    authType

    Specifies the authentication type of an SSH user.

    sftpDir

    Specifies the name of a directory on the SFTP server.

    sshServiceType

    Specifies the service type of an SSH user.

    pubKeyType

    Specifies the public key type of an SSH user.

    keyNam

    Specifies the name of a configured public key.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply>
      <data>
        <sshs xmlns="http://www.huawei.com/netconf/vrp" format-version="1.0" content-version="1.0">
          <sshUserCfgs>
            <sshUserCfg>
              <userName>root123</userName>
              <authType>password</authType>
              <sshServiceType>all</sshServiceType>
              <keyName/>
              <sftpDir/>
              <pubKeyType>NotSet</pubKeyType>
            </sshUserCfg>     
          </sshUserCfgs>
        </sshs>
      </data>
    </rpc-reply>

    Table 3-208 describes elements in responses.

    Table 3-208  Elements

    Element

    Description

    userName

    Specifies the name of an SSH user.

    authType

    Specifies the authentication type of an SSH user.

    sftpDir

    Specifies the name of a directory on the SFTP server.

    sshServiceType

    Specifies the service type of an SSH user.

    pubKeyType

    Specifies the public key type of an SSH user.

    keyNam

    Specifies the name of a configured public key.

Configure SSH Users

Operation

URI

Description

PUT

/sshs/sshUserCfgs/sshUserCfg

Configure SSH users.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?>
    <sshUserCfg>
        <userName> testuser </userName>
        <authType>rsa</authType>
        <userName> testuser </userName>
        <sftpDir>cfcard:/ssh</sftpDir> 
        <userName> testuser </userName>
        <sshServiceType>sftp</sshServiceType> 
        <userName>test</userName>
        <authType>dsa</authType>
        <sftpDir></sftpDir>
        <keyName>dsa</keyName>
        <sshServiceType>all</sshServiceType>
        <pubKeyType>DSA</pubKeyType>   
    </sshUserCfg>

    Table 3-209 describes elements in requests.

    Table 3-209  Elements

    Element

    Description

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    authType

    Specifies an authentication type.

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    sftpDir

    Specifies the name of a directory on the SFTP server. The name is a string of 1 to 128 characters.

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    sshServiceType

    Specifies the service type of an SSH user.

    userName

    Specifies the name of an SSH user. The name is a string of 1 to 253 characters, spaces not supported.

    pubKeyType

    Specifies the public key type of an SSH user.

    keyName

    Specifies the name of a configured public key.

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

    Table 3-210 describes status codes in responses.

    Table 3-210  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 SSH Users

Operation

URI

Description

DELETE

/sshs/sshUserCfgs/sshUserCfg

Delete SSH users.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?>
    <sshUserCfg>
        <userName>testuser</userName>   
    </sshUserCfg>

    Table 3-211 describes elements in requests.

    Table 3-211  Elements

    Element

    Description

    userName

    Specifies the name of an SSH user.

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

    Table 3-212 describes status codes in responses.

    Table 3-212  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: 30848

Downloads: 127

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