REST Resources

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

The following operation is supported on this resource:

  • POST - Create RPC request on the device
POST /devices/{id}/exec-rpcVersion 3

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 the executed RPC commmands.

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/>]] is incorrect.

The following input is correct:

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

.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /devices/{id}/exec-rpc?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    device-idIntegerPathThe ID of the device on which to perform the RPC command. Y
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:

    Using CDATA
    <netconf>
      <rpcCommands>
        <rpcCommand>
          <![CDATA[<get-system-information/>]]>
        </rpcCommand>
      </rpcCommands>
    </netconf>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/1212438">
      <id>1212438</id>
    </task>

  • Sample Input JSON:

    {
      "netconf":{
        "rpcCommands":{
          "rpcCommand": ["{\"get-system-information\":\"\"}"]
        }
      }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href":"/api/space/job-management/jobs/1212438",
        "id":1212438
      }
    }

    • Access Control

    The following capabilities are required to access this API: OpenSSH