pman command: template page

pman command: template page

Abstract

This page is a template for pman command detail.

Preconditions

These are the preconditions that must be satisfied for the page contents to be valid.

• This page assumes that pman is listening on: 172.17.0.2:5010.
• Make sure that pman has been started (see here for more info):

pman --rawmode 1 --http  --port 5010 --listeners 12

msg summary

This section contains the msg JSON string transmitted to pman:

 {  "action": "someAction",
         "meta": {
                 "metaVar1":     "var1_value",
                 "metaVar2":     "var2_value"
         }
 } 

someAction

purl prefix

Start the purl command with

purl --verb POST --raw --http 172.17.0.2:5010/api/v1/cmd --jsonwrapper 'payload' --msg \

simple copy/paste the above line into a terminal. Do not press enter!

msg suffix

This section describes transmitting the action using purl:

Append (copy/paste) the following to the purl prefix command above and hit enter:

' {  "action": "someAction",
         "meta": {
                 "metaVar1":     "var1_value",
                 "metaVar2":     "var2_value"
         }
 }'

return payload

This documents the return JSON payload from pman:

{
    "someField": "someValue"
}

--30--