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

The following operations are supported on this resource:

• POST

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

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/>]]

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.

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

Parameters

Content Types

• Consumes content types:
  application/vnd.net.juniper.space.device-management.rpc+xml;version=3;charset=UTF-8
  application/vnd.net.juniper.space.device-management.rpc+json;version=3;charset=UTF-8



• Produces content types:
  application/vnd.net.juniper.space.device-management.rpc+xml;version=3
  application/vnd.net.juniper.space.device-management.rpc+json;version=3



• Sample Input XML:
  
Using CDATA
<netconf>
  <rpcCommands>
    <rpcCommand>
      <![CDATA[<get-system-information/>]]>
    </rpcCommand>
  </rpcCommands>
</netconf>




• Sample Input XML:
  
Using the Escape Sequence
<netconf>
  <rpcCommands>
    <rpcCommand>
      &lt;get-system-information/&gt;
    </rpcCommand>
  </rpcCommands>
</netconf>



• Sample Output XML:
  
<task>
   <id>884737</id>
</task>




• Sample Input JSON:
  
{
"netconf":
   {
   "rpcCommands":
   {
      "rpcCommand": ["{\"get-system-information\":\"\"}"]
      }
   }
}




• Sample Output JSON:
  
{"task":{"id":917507}}

For other non-deprecated versions of this API, refer to :

• version 2


• version 1