Networking NVIDIA UFM Enterprise REST API Guide

Update Credentials REST API

Get Device Credentials

  • Description: Retrieves device credentials in UFM.

  • Request: GET /ufmRest/resources/systems/<dev_name>/credentials?credential_types=<type>

    The type parameter can be one of the following:

    • SSH_Server

    • SSH_Switch

    • MLNX-OS

    • IPMI

  • Response data:

    [
      {
        "type": "IPMI",
        "user": "admin",
        "port": 623,
        "timeout": "N\/A",
        "name": "IPMI",
        "credentials": "*******"
      }
    ]
    
  • Request content type: application/json

  • Note:

    • Credentials always return asterisks (***) instead of the actual text.

  • Status codes:

    • 200: Credentials were updated successfully

    • 400: Bad request (bad or missing parameters)

    • 404: System not found

Get Site Credentials

  • Description: Retrieves site credentials in UFM.

  • Request: GET /ufmRest/resources/sites/<site_name>/credentials?credential_types=<type>

    The type parameter can be one of the following:

    • SSH_Server

    • SSH_Switch

    • MLNX-OS

    • IPMI

  • Response data:

    [
      {
        "type": "IPMI",
        "user": "admin",
        "port": 623,
        "timeout": "N\/A",
        "name": "IPMI",
        "credentials": "*******"
      }
    ]
    
  • Request content type: application/json

  • Note:

    • Credentials always return asterisks (***) instead of the actual text.

  • Status codes:

    • 200: Credentials were updated successfully

    • 400: Bad request (bad or missing parameters)

Update Device Credentials

  • Description: Updates device credentials in UFM.

  • Request: PUT /ufmRest/resources/systems/<name1>,<name2>,…/credentials

    <name1> and <name2> are the system's <name> attribute that should be updated.

  • Request data:

    }
    	"type": "SSH_Server"/"SSH_Switch"/"IPMI"/"SNMP"/"TELNET"/"MLNX_OS",
    	"user": "<username>",
    	"password": "<password>",
    	"port": <port>*,
    	"timeout": <timeout>*
        "use_manual_ip": true/false,
    	"ip": <ip>
    }
    

    The value of this attribute can only be an integer and not a string.

  • Request content type: application/json

  • Notes:

    • The type attribute is mandatory. The other attributes are optional.

    • If you have not updated the user and password attributes before, include both attributes in the first update.
      Response

  • Status codes:

    • 200: Credentials were updated successfully

    • 400: Bad request (bad or missing parameters)

    • 404: System not found

Update Site Credentials

  • Description: Updates site credentials in UFM.

  • Request: PUT /ufmRest/resources/sites/<site_name>/credentials

  • Request data:

    {
        "type": "SSH_Server"/"SSH_Switch"/"IPMI"/"MLNX_OS",
        "user": "<username>",
        "password": "<password>",
        "port": <port>,
        "keep_old_pwd": true,
        "timeout": <timeout>
    }
    
  • Request content type: application/json

  • Notes:

    • The default site name is default.

    • The type attribute is mandatory. The other attributes are optional.

    • If you have not updated the user and password attributes before, include both attributes in the first update.

    • Set keep_old_pwd to true to keep the previous password operational during the transition period when you change the switch password in large-scale fabrics. This setting applies only to the MLNX_OS credentials type. The default value is false.

  • Response: N/A

  • Status codes:

    • 200: Credentials were updated successfully

    • 400: Bad request (bad or missing parameters)

    • 404: System not found

Last updated: