Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Install Script Bundle on a Device

 

Use this API to install a script bundle on a device managed by Service Now. The Retrieve Job Details API https://{host-id} api/space/job-management/jobs/{jobs-id} outputs the URI for this API.

URI

https://{host-id}/api/juniper/servicenow/event-profile-management/eventProfiles/ job-instances/{job-id}/event-profiles-install-job-results

URI Parameters

Parameter

Type

Required

Description

job-id

Integer

Yes

ID of the job for installing service bundle on a device

Consumes

None

Produces

None

Response Elements

Element

Type

Description

uri

String

URI to the collection of install script bundle job results

total

Integer

Number of records in the collection

jobResult

jobResult

A install script bundle job result

id

Integer

ID of the script bundle in Service Now database

profileId

Integer

ID of the event profile associated with the script bundle

bundleId

Integer

ID of the script bundle in Junos Space

jobType

String

Type of job; the value is always Install in this operation

serviceNowDeviceID

Integer

ID of the device on which the script bundle is installed in the Service Now database

spaceDeviceID

Integer

ID of the device on which the script bundle is installed in Junos Space Network Management Platform

jobStatus

String

Status of the script bundle installation job

Possible values are:

  • Success—The script bundle successfully installed on the device.

  • Failed—The script bundle failed to install on the device.

  • Scheduled—The script bundle is scheduled to be installed on the device.

jobRemarks

String

Remarks about the script bundle installation job

jobSteps

jobSteps

Provides details about the steps performed for installing the script bundle on the device and the results of each step

The steps include:

  • Connecting to the device

  • Copying the script bundle to the device

  • Installing the script bundle on the device

  • Copying the .slax files to the device

  • Committing the .slax files on the device

id

Integer

ID of the job step

stepName

String

Name of the step

jobStatus

String

Status of the step in the installation job

detailedJobRemarks

String

Remarks about the step

Sample Output

Sample XML Output

Sample JSON Output

Error Codes

Message

Description

200 OK

The script bundle was installed correctly.