
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT configure/device/scheduleMaintenanceMode

Creates a job to set maintenance mode. This resource is intended for use with routers, switches, wireless controllers, autonomous access points, and other types of devices except for unified access points. To get the current management status and the maintenance mode reason for a device, see the "managementStatus" and "collectionDetail" response parameters from Devices.

Since Product Version: 3.4

- Jump To

- v1
- v2
- v3
- v4

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | PUT

## Resource URL

/webacs/api/v4/op/configure/device/scheduleMaintenanceMode

## Request Parameters

Attribute | Source | Description
--- | --- | ---
scheduledTime Date | query | Optional The time when the job will be launched. If the time is not specified the job will be started immediately.

## Request Payload Parameters

Attribute | Description
--- | ---
deviceIds Long[] | Required List of device IDs.
maintenanceMode Boolean | If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false.
reason String | Reason for moving devices into the maintenance mode. Optional. This attribute will be ignored if the attribute 'maintenanceMode' is false.

## Response Parameters

Attribute | Description
--- | ---
errorMessage String | Message returned if any exception comes
jobName String | Job name which is created by the system
status ConfigureServiceJobStatus | Job status Allowed values SUCCESS FAILURE

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v4/op/configure/device/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z

    <?xml version="1.0" ?>
    <deviceMaintenanceModeConfigDTO>
      <deviceIds>
        <deviceId>15</deviceId>
        <deviceId>25</deviceId>
      </deviceIds>
      <maintenanceMode>true</maintenanceMode>
      <reason>String value</reason>
    </deviceMaintenanceModeConfigDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/configure/device/scheduleMaintenanceMode.json?scheduledTime=2038-01-19T03:14:17Z

    {
      "deviceMaintenanceModeConfigDTO" : {
        "deviceIds" : {
          "deviceId" : [ 15, 25 ]
        },
        "maintenanceMode" : true,
        "reason" : "String value"
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v4/op/configure/device/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v4/op/configure/device/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <configureJobResultDTO>
        <errorMessage>String value</errorMessage>
        <jobName>String value</jobName>
        <status>SUCCESS</status>
      </configureJobResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/configure/device/scheduleMaintenanceMode.json?scheduledTime=2038-01-19T03:14:17Z

    {
      "mgmtResponse" : {
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/op/configure/device/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "configureJobResultDTO" : [ {
          "errorMessage" : "String value",
          "jobName" : "String value",
          "status" : "SUCCESS"
        } ]
      }
    }