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).
Public Key Configuration for an SSH Server

Public Key Configuration for an SSH Server

Create Public Keys for an SSH Server

Operation

URI

Description

POST

/sshc/sshCliKeyCfgs/sshCliKeyCfg

Create public keys for an SSH server. The SSH client assigns public keys to the SSH server. The keys must be RSA/DSA/ECC public keys of the SSH server that is configured on the SSH client.

By default, no public key is assigned to the SSH server.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?>
    <sshCliKeyCfg>
        <serverName>10.1.1.1</serverName>
        <keyName>rsa</keyName>
        <pubKeyType>RSA</pubKeyType>       
    </sshCliKeyCfg>

    Table 3-175 describes elements in requests.

    Table 3-175  Elements

    Element

    Description

    serverName

    Specifies an SSH server address. (Mandatory)

    keyName

    Specifies a public key name. (Mandatory)

    pubKeyType

    Specifies a public key type: RSA, DSA, or ECC. (Mandatory)

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

    Table 3-176 describes status codes in responses.

    Table 3-176  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 Public Keys of an SSH Server

Operation

URI

Description

GET

/sshc/sshCliKeyCfgs/sshCliKeyCfg

Query the public keys assigned by an SSH client to the SSH server. The keys must be RSA/DSA/ECC public keys that are currently used for the SSH server.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <sshCliKeyCfg>
        <serverName/>
        <keyName/>
        <pubKeyType/>   
    </sshCliKeyCfg>

    Table 3-177 describes elements in requests.

    Table 3-177  Elements

    Element

    Description

    serverName

    Specifies an SSH server address.

    keyName

    Specifies a public key name.

    pubKeyType

    Specifies a public key type: RSA, DSA, or ECC.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <sshCliKeyCfg>
        <serverName>10.0.0.1<serverName/>
        <keyName>dsakey001<keyName/>
        <pubKeyType>ECC<pubKeyType/>   
    </sshCliKeyCfg>

    Table 3-178 describes elements in responses.

    Table 3-178  Elements

    Element

    Description

    serverName

    Specifies an SSH server address.

    keyName

    Specifies a public key name.

    pubKeyType

    Specifies a public key type: RSA, DSA, or ECC.

    Table 3-179 describes status codes in responses.

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

Configure Public Keys for an SSH Server

Operation

URI

Description

PUT

/sshc/sshCliKeyCfgs/sshCliKeyCfg

Configure public keys for an SSH server.

The SSH client assigns public keys to the SSH server. The keys must be RSA/DSA/ECC public keys of the SSH server that is configured on the SSH client.

By default, no public key is assigned to the SSH server.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?>
    <sshCliKeyCfg>
        <serverName>10.1.1.1</serverName>
        <keyName>rsa</keyName>
        <pubKeyType>RSA</pubKeyType>
    </sshCliKeyCfg>

    Table 3-180 describes elements in requests.

    Table 3-180  Elements

    Element

    Description

    serverName

    Specifies an SSH server address.

    keyName

    Specifies a public key name.

    pubKeyType

    Specifies a public key type: RSA, DSA, or ECC.

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

    Table 3-181 describes status codes in responses.

    Table 3-181  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 Public Keys of an SSH Server

Operation

URI

Description

DELETE

/sshc/sshCliKeyCfgs/sshCliKeyCfg

Delete the public keys assigned by an SSH client to the SSH server. The keys must be RSA/DSA/ECC public keys of the SSH server that is configured on the SSH client.

  • Request example:
    <?xml version="1.0" encoding="UTF-8"?>
    <sshCliKeyCfg>
        <serverName>10.1.1.1</serverName>
        <pubKeyType>RSA</pubKeyType>
    </sshCliKeyCfg>

    Table 3-182 describes elements in requests.

    Table 3-182  Elements

    Element

    Description

    serverName

    Specifies an SSH server address.

    pubKeyType

    Specifies a public key type: RSA, DSA, or ECC.

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

    Table 3-183 describes status codes in responses.

    Table 3-183  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: 27472

Downloads: 121

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