Device Management API

/api/space/device-management/devices/{id}/exec-rpc (v2)

The following operations are supported on this resource:

POST /api/space/device-management/devices/{id}/exec-rpc (v2)


This API creates a schedulable RPC request on the specified device. It executes the different RPC commands after opening a channel to the device and sets the status of executed RPC commmands. The API requires the device ID and a netconf transfer object that contains the RPC commands to be performed at the scheduled time.

Note: The RPC command to be executed must not contain any <rpc> tags. For example, the following is incorrect:

   ![CDATA[<rpc><get-system-information/><rpc/>]]

The following input is correct:

   ![CDATA[<get-system-information/>]]

.

Access Control

The following capabilities are required to access this API:
"OpenSSH"


Example Usage

Since this API makes an asynchronous method call, the user must specify a queue parameter with this API.

POST /api/space/device-management/devices/{id}/exec-rpc?queue-url=<queue-url>&schedule-time=<schedule-time>

Note: It is assumed that the queue denoted by <queue-url> has, already, been created.



Parameters

NameTypeURI TypeDescriptionRequired
device-idIntegerPathThe ID of the device on which to perform the RPC operation. Y
queue-urlURLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)Y
schedule-timecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N

Content Types


    For the current version of this API, refer to :
  • version 3