Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Configure Maintenance Mode

 

Use this API to move a device to maintenance mode.

When a device is in maintenance mode, you cannot generate on-demand JMBs or device snapshots and configure BIOS validations or configure product health data checks.

URI

/api/juniper/servicenow/device-management/devices/{id}//configureMaintenanceMode? queue=http://[host]/api/hornet-q/queues/jms.queue.queuename(HTTP method = GET)

/api/juniper/servicenow/device-management/devices/configureMaintenanceMode? queue=http://[host]/api/hornet-q/queues/jms.queue.queuename(HTTP method = POST)

Element

Type

Required

Description

id

Integer

Yes

ID of the device to be moved to maintenance mode

queuename

String

Yes

Name of the configure maintenance mode job queue

Consumes

  • application/vnd.juniper.servicenow.device-management.configuremaintenancemode+xml; version=1;charset=UTF-8

  • aapplication/vnd.juniper.servicenow.device-management.configuremaintenancemode+json; version=1;charset=UTF-8

Request Elements

Element

Type

Description

devices

devices

Collection of Service Now devices

device

device

A Service Now device

uri

String

URI of the Service Now device to be moved to maintenance mode

href

String

Link to the Service Now device

maintenanceMode

String

Flag to enable or disable maintenance mode on the device

Possible values:

  • enable—Device is placed in maintenance mode

  • disable—Device is not placed in maintenance mode

applyToAllDevices

Boolean

Flag to apply the maintenance mode setting on all other devices

Possible values:

  • true—All Service Now devices are placed in maintenance mode

  • false—All Service Now devices are not placed in maintenance mode

This is an optional element.

Produces

  • application/vnd.juniper.servicenow.device-management.device+xml;version=1

  • application/vnd.juniper.servicenow.device-management.device+json;version=1

Response Elements

Element

Type

Description

href

String

Link to the confiure maintenance mode job

id

Integer

ID of the job

Sample Input

Sample XML Input

Sample JSON Input

Sample Output

Sample XML Output

Sample JSON Output