Templates REST API

• Description – API for using provisioning templates in UFM (getting, adding and refreshing templates)

• Request URL – /ufmRest/templates

• Main Operations

  • Get all templates

  • Get template

  • Add template

  • Remove template

  • Refresh templates list

• Description – this interface is used to retrieve all templates

• Request URL – GET /ufmRest/templates

• Optional Request Parameters

  "tags"	Comma seperated list of tags. For example: .../templates?tags="switch,Mellanox"
  "profile"	Profile of the template. For example: .../templates?profile="ib"
  "system_type"	Type of system. For example: .../templates?system_type=Mellanox Switch

• Request Data – N/A

• Response

  Copy

  Copied!

              
  
              
  [{
     "matchingValidationTemplate": null,
     "description": "Shows SNMP settings and status",
     "filePath": "/opt/ufm/files/templates/pre-defined/Mellanox/Show-SNMP",
     "validationTemplate": null,
     "portProvisioning": null,
     "systemProfile": "",
     "parsingScript": null,
     "systemType": "Mellanox Switch",
     "owner": "*system*",
     "title": "Show-SNMP",
     "tags": "switch,Mellanox"
  },
  {
     "matchingValidationTemplate": null,
     "description": "Displays health report.",
     "filePath": "/opt/ufm/files/templates/pre-defined/Mellanox/Show-Health-Report",
     "validationTemplate": null,
     "portProvisioning": null,
     "systemProfile": "",
     "parsingScript": null,
     "systemType": "Mellanox Switch",
     "owner": "*system*",
     "title": "Show-Health-Report",
     "tags": "switch,Mellanox"
  },
  .
  .
  .
          

• Status Codes

  • 200 – successful operation

• Description – this interface is used to retrieve the content of a specific template

• Request URL – GET /ufmRest/<templates>/<template_name>

• Request Data – N/A

• Response

  Copy

  Copied!

              
  
              
  {
     "matchingValidationTemplate": null,
     "description": "Shows SNMP settings and status",
     "filePath": "/opt/ufm/files/templates/pre-defined/Mellanox/Show-SNMP",
     "validationTemplate": null,
     "portProvisioning": null,
     "systemProfile": "",
     "content": [
     "#!desc: Shows SNMP settings and status\n",
     "#!system_profile:\n",
     "#!system_type: mlnxos_switch\n",
     "#!update_conf: false\n",
     "#!owner: *system*\n",
     "show snmp\n"
  ],
     "parsingScript": null,
     "systemType": "Mellanox Switch",
     "owner": "*system*",
     "title": "Show-SNMP",
     "tags": "switch,Mellanox"
  }
          

• Status Codes

  • 200 – successful operation

  • 400 – template <template_name> does not exist

• Description – this interface is used to add/create a new user-defined template

• Request URL – POST /ufmRest/<templates>

• Request Data

  Copy

  Copied!

              
  
              
  {
    "title": "tenplate_title",
    "systemType": "Mellanox Switch",
    "content":["the content of the template"],
    "description": "template_description"
  }
          

• Response – HTTP Response Location Header will contain URI with template name created for running the CLI command on the specified switches

• Status Codes

  • 201 – created

  • 409 – template with a name 'template_title' already exists. Please select a different name.

  • 400 – missing attribute(s) : attr_name

• Description – this API is used to remove an existing template

• Request URL – DELETE /ufmRest/<templates>/<template-id>

• Request Data – N/A

• Response – N/A

• Status Codes

  • 204 – no content

• Description – this interface is used to refresh the templates list, after a new user-defined template was created

• Request URL – POST /ufmRest/<templates>/refresh

• Request Data – N/A

• Response – N/A

• Status Codes

  • 200 – OK

General Templates

InfiniBand Templates