image image image image image

YOU ARE VIEWING AN OUTDATED DOCUMENT.

On This Page

  • Description – these interfaces allow users to retrieve various sorts of jobs data in UFM
  • Request URL – /ufmRest/jobs

  • Main Operations

    OperationRequest URL

    All jobs

    GET /ufmRest/jobs

    Specific jobsGET /ufmRest/jobs/<List of JobIDs>*
    Job informationGET /ufmRest/jobs/job-id/info
    Job information in JSONGET /ufmRest/jobs/job-id/info?type=full_json
    Sub jobs of a specific jobGET /ufmRest/jobs/job_Id?advanced_information=true
    Parent jobs onlyGET /ufmRest/jobs?parent_id=null
    Jobs for systemGET /ufmRest/jobs?object_ids=<list_of_systems>*
    Jobs for operationGET /ufmRest/jobs?operation=operation_name
    Jobs with a specific statusGET /ufmRest/jobs?status=job_status
    Update job statusPUT /ufmrest/jobs/status=Aborted
    Delete a jobDELETE /ufmRest/jobs/<job-id>

    Abort all jobs

    		POST /ufmRest/jobs/abortall

    *Values are separated with commas. e.g.1,2,3

  • Request Data – N/A

  • Response Example 

    {
	"Status": "Completed",
	"Foreground": true,
	"Description": " Shows SNMP settings and status",
	"RelatedObjects": ["10.209.36.140"],
	"Created": "2017-04-25 14:50:29",
	"LastUpdated": "2017-04-25 14:50:36",
	"Summary": "show snmp\n\nSNMP enabled: yes\nSNMP port: 161\nSystem contact: \nSystem         location:
        \n\nRead-only communities:\n public\n\nRead-write communities:\n (none)\n\nInterface         listen
        enabled: yes\nNo Listen Interfaces.\n",
	"CreatedBy": "admin",
	"Progress": 100,
	JobsRESTAPIRev5.9MellanoxTechnologies35Note: Ifaninvalidoranon-        existingsystemorjobIDwerespecified,
	anemptylistwillbereturned."Operation": "Provisioning",
	"ID": "1.1"
}

    If an invalid or a non-existing system or job ID were specified, an empty list is returned.

  • Status Codes

    • 200 – successful operation

    • 404 – not found