EBF REST APIs

Authentication token

From Command line terminal:

1
2
3
 curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/token/' \
      --header 'Content-Type: application/json' \
      --data-raw '{"username": "{ username }","password":"{password}"}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 curl --location --request POST 'https://172.16.30.138/api/v0.2/token/' \
      --header 'Content-Type: application/json' \
      --data-raw '{"username": "testuser", "password":"test"}'

 {
     "result": "success",
     "data": {
         "token": "ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy"
     }
 }

Device Management

List Devices

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
https://172.16.30.102/api/v0.2/devices/

{
    "result": "success",
    "data": [
        "rpi01",
        "bbb01",
    ],
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/' \
      --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location --request 'https://172.16.30.102/api/v0.2/devices/' \
      --header 'Authorization: token ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy'

{
    "result": "success",
    "data": [
        "rpi01",
        "bbb01",
    ],
    "version": "2.4.0"
}

Allocate Device

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/{device name}/assign/

Example:

1
2
3
4
5
6
https://172.16.30.102/api/v0.2/devices/bbb01/assign/

{
    "result": "success",
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/{device name}/assign/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request 'https://172.16.30.102/api/v0.2/devices/bbb01/assign/' \
      --header 'Authorization: token ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy'

{
    "result": "success",
    "version": "2.4.0"
}

Release Device

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/{device name}/release/

To release device assigned to some other user:

1
https://{EBF Server IP Address}/api/v0.2/devices/{device name}/release/force/

Example:

1
2
3
4
5
6
https://172.16.30.102/api/v0.2/devices/bbb01/release/

{
    "result": "success",
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/{device name}/release/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request GET 'https://172.16.30.102/api/v0.2/devices/bbb01/release/' \
      --header 'Authorization: token ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy'

{
    "result": "success",
    "version": "2.4.0"
}

Device Release (force)

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/device-name/release/force

Example:

1
2
3
4
5
6
https://172.16.30.102/api/v0.2/devices/bb01/release/force/

{
    "result": "success",
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/device-name/release/force/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request GET 'https://172.16.30.102/api/v0.2/devices/device-name/release/force/' \
      --header 'Authorization: token ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy'

{
    "result": "success",
    "version": "2.4.0"
}

My Devices

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/mine/

Example:

1
2
3
4
5
6
7
8
9
https://172.16.30.102/api/v0.2/devices/mine/

{
    "result": "success",
    "data": [
        "bbb01",
    ],
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/mine/' \
      --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request GET 'https://172.16.30.102/api/v0.2/devices/mine/' \
      --header 'Authorization: token ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy'

{
    "result": "success",
    "data": [
        "bbb01",
    ],
    "version": "2.4.0"
}

Device Info

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/{device name}/

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
https://172.16.30.102/api/v0.2/devices/dev3/

{
    "result": "success",
    "data": {
        "Hostname": "dev3",
        "AssignedTo": "",
        "ForceReleaseAllowed": true,
        "PowerCommands": [
            "on",
            "off",
            "reboot",
            "status"
        ],
        "ConsoleSharing": true,
        "NumConsoles": 4,
        "lab": {
            "Zombie": {
                "Hostname": "TimesysZombie_204",
                "IPAddress": "172.16.30.204",
                "URL": "http://172.16.30.204/",
                "DevicePort": 1,
                "AppZombieConnected": false
            },
            "IOCXConnected": false,
            "Power": {
                "PowerSwitch": "digital_IP_Power_switch",
                "PowerSwitchPort": 6
            },
            "NetworkBoot": {
                "NetbootType": "",
                "TFTP Boot Directory": "upload/DUT1",
                "NFS Root Directory": "/var/lib/lava/dispatcher/tmp/nfs/DUT1/tmp",
                "NetbootDetails": {}
            }
        }
    },
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/{device name}/' \
      --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
curl --location --request GET 'https://172.16.30.102/api/v0.2/devices/dev3/' \
      --header 'Authorization: token ujpy0cpf2g9e0ydqp0pmbgr6hsdcxclcysigs062hynqm41dqnrdgukysjjgl5nwwp1jtp50ep4qbfte1c0o3gw77ldwk6m5swopj3snlh7o0e1y54qn78r68wpyf5oy'

{
    "result": "success",
    "data": {
        "Hostname": "dev3",
        "AssignedTo": "",
        "ForceReleaseAllowed": true,
        "PowerCommands": [
            "on",
            "off",
            "reboot",
            "status"
        ],
        "ConsoleSharing": true,
        "NumConsoles": 4,
        "lab": {
            "Zombie": {
                "Hostname": "TimesysZombie_204",
                "IPAddress": "172.16.30.204",
                "URL": "http://172.16.30.204/",
                "DevicePort": 1,
                "AppZombieConnected": false
            },
            "IOCXConnected": false,
            "Power": {
                "PowerSwitch": "digital_IP_Power_switch",
                "PowerSwitchPort": 6
            },
            "NetworkBoot": {
                "NetbootType": "",
                "TFTP Boot Directory": "upload/DUT1",
                "NFS Root Directory": "/var/lib/lava/dispatcher/tmp/nfs/DUT1/tmp",
                "NetbootDetails": {}
            }
        }
    },
    "version": "2.4.0"
}

Device delete

From Command line terminal

1
2
curl --location --request DELETE 'https://{EBF Server IP Address}/api/v0.2/devices/{device name}/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request DELETE https://172.16.7.21/api/v0.2/devices/rpi-board/ \
      --header 'Authorization: token 22nbjxec52gxfpz32t82cqb7twfk9b2llrlaxfm2jl4ftkfhnxylyidsae260ajqfp2lk3r0l02crugak42yoy7tt90sn4flo20zt13ibuc0yfnb0xjgxsg3tcry33am'

{
  "result": "success",
  "version": "2.4.0"
}

Console Sharing Control

Status

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/console/sharing/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl -k --location --request GET 'https://172.16.30.27/api/v0.2/devices/bbb-demo/console/sharing/' \
      --header 'Authorization: token geqaffqpmzy25xzeas7zrebbq6qfe4x6jr6r44hpl288z2ypeq08dotg7e6qycywubmx0c5m9sy7ih2qecuwl89o87tj1gucxu0t006xd0olm2n471rolzs2jn7fq6f1'

{
   "data": true,
   "result": "success",
   "version": "2.4.0"
}

Enable

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/console/sharing/true/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl -k --location --request PUT 'https://172.16.30.27/api/v0.2/devices/bbb-demo/console/sharing/true/' \
      --header 'Authorization: token geqaffqpmzy25xzeas7zrebbq6qfe4x6jr6r44hpl288z2ypeq08dotg7e6qycywubmx0c5m9sy7ih2qecuwl89o87tj1gucxu0t006xd0olm2n471rolzs2jn7fq6f1'

{
   "message":" Successfully enabled console sharing for this device.",
   "result": "success",
   "version": "2.4.0"
}

Disable

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/console/sharing/false/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl -k --location --request PUT 'https://172.16.30.27/api/v0.2/devices/bbb-demo/console/sharing/false/' \
      --header 'Authorization: token geqaffqpmzy25xzeas7zrebbq6qfe4x6jr6r44hpl288z2ypeq08dotg7e6qycywubmx0c5m9sy7ih2qecuwl89o87tj1gucxu0t006xd0olm2n471rolzs2jn7fq6f1'

{
   "message":"Successfully disabled console sharing for this device.",
   "result":"success",
   "version":"2.4.0"
}

Power Control

ON

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/power/on/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/power/on/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "on",
  "result": "success",
  "version": "2.4.0"
}

OFF

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/power/off/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/power/on/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "success",
  "version": "2.4.0"
}

REBOOT

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/power/reboot/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/power/reboot/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "success",
  "version": "2.4.0"
}

User Defined

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<devicename>/power/<userDefinedCommand>/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/power/status/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "success",
  "version": "2.4.0"
}

Zombie Power Control

ON

From Command line terminal

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location ---request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/on \
      --header 'Authorization: token {Authorization token}'

curl --location --request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/on \
      --header 'Authorization: token 22nbjxec52gxfpz32t82cqb7twfk9b2llrlaxfm2jl4ftkfhnxylyidsae260ajqfp2lk3r0l02crugak42yoy7tt90sn4flo20zt13ibuc0yfnb0xjgxsg3tcry33am'

{
  "result": "success",
  "data": "curl https://ADMIN:1234@172.16.30.99/OUTLET?1=ON",
  "version": "2.4.0"
}

OFF

From Command line terminal

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location ---request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/off \
      --header 'Authorization: token {Authorization token}'

curl --location --request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/off \
      --header 'Authorization: token 22nbjxec52gxfpz32t82cqb7twfk9b2llrlaxfm2jl4ftkfhnxylyidsae260ajqfp2lk3r0l02crugak42yoy7tt90sn4flo20zt13ibuc0yfnb0xjgxsg3tcry33am'

{
  "result": "success",
  "data": "curl https://ADMIN:1234@172.16.30.99/OUTLET?1=OFF",
  "version": "2.4.0"
}

REBOOT

From Command line terminal

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
curl --location ---request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/reboot/ \
      --header 'Authorization: token {Authorization token}'

curl --location --request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/off/ \
      --header 'Authorization: token 22nbjxec52gxfpz32t82cqb7twfk9b2llrlaxfm2jl4ftkfhnxylyidsae260ajqfp2lk3r0l02crugak42yoy7tt90sn4flo20zt13ibuc0yfnb0xjgxsg3tcry33am'

{
  "result": "success",
  "data": "curl https://ADMIN:1234@172.16.30.99/OUTLET?1=OFF",
  "version": "2.4.0"
}

curl --location --request POST https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01/power/on/ \
      --header 'Authorization: token 22nbjxec52gxfpz32t82cqb7twfk9b2llrlaxfm2jl4ftkfhnxylyidsae260ajqfp2lk3r0l02crugak42yoy7tt90sn4flo20zt13ibuc0yfnb0xjgxsg3tcry33am'

{
  "result": "success",
  "data": "curl https://ADMIN:1234@172.16.30.99/OUTLET?1=ON",
  "version": "2.4.0"
}

Device Serial Console

List consoles

From Command line terminal

1
2
 curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/serial/' \
        --header 'Authorization: token {Authorization token}' \

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb-demo/serial/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \

{
    "result": "success",
    "data": {
        "NumConsoles": 1,
        "ConsoleSharing": true
    },
    "version": "2.4.0"
}

Upload

From Command line terminal

1
2
3
4
 curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/upload/serial/' \
        --header 'Authorization: token {Authorization token}' \
        --form 'file=@"{File Path}"' \
        --form 'path={file upload path}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb-demo/upload/serial/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
     --form 'file=@"/home/hbansal/Isos/MLO-cmm-2019.01+gitAUTOINC+4fa6070cdd-r32" --form 'path=/home''

{
    "message": "MLO-cmm-2019.01+gitAUTOINC+4fa6070cdd-r32 uploaded",
    "result": "success"
}

Download

From Command line terminal

1
2
3
 curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/download/serial?path={File path to download}' \
        --header 'Authorization: token {Authorization token}' \
        --output '{Saved file}'

Example:

1
2
3
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/download/serial?path=/etc/profile' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
     --output 'profile'

Run Command

From Command line terminal

1
2
3
 curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/run/serial/' \
        --header 'Authorization: token {Authorization token}' --header 'Content-Type: application/json' \
        --data-raw '{"command":["{Command}"],"prompts":["{prompt to check for completion, default:empty}"],"timeout": {timeout in secs default:5},"console":"{console name default: first console}"}'

Example:

Run command on first console

1
2
3
4
5
6
7
8
9
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/run/serial/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --header 'Content-Type: application/json' --form --data-raw '{"command": ["whoami"]}'

{
    "data": ["root"],
    "result": "success",
    "version": "2.4.0"
}

Run command on a chosen console

1
2
3
4
5
6
7
8
9
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/run/serial/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --header 'Content-Type: application/json' --form --data-raw '{"command": ["whoami"], "console": "serial0"}'

{
    "data": ["root"],
    "result": "success",
    "version": "2.4.0"
}

Start

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/serial/start/<console name: optional>/

Example:

1
2
3
4
5
6
7
https://172.16.3.21/api/v0.2/devices/bbb_demo/console/serial/start/

{
  "message": "Device session successfully started",
  "result": "success",
  "version": "2.4.0"
}

From Command line terminal

1
2
 curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/serial/start/<console name: optional>/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/console/serial/start/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "message": "Device session successfully started",
  "result": "success",
  "version": "2.4.0"
}

Stop

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/serial/stop/<console name: optional>/

Example:

1
2
3
4
5
6
7
https://172.16.3.21/api/v0.2/devices/bbb_demo/console/serial/stop/

{
  "message": "Device session successfully stopped",
  "result": "success",
  "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/serial/stop/<console name: optional>/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/console/serial/stop/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "message": "Device session successfully stopped",
  "result": "success",
  "version": "2.4.0"
}

Status

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/serial/status/<console name: optional>/

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
https://172.16.3.21/api/v0.2/devices/bbb_demo/console/serial/status/

{
  "data": {
    "dut_number": 1,
    "isActive": true,
    "status": {
         "serial0": true,
         "serial1": false,
         "serial2": false,
         "serial3": true,
         "serial4": false,
         "serial5": false,
         "serial6": false,
         "serial7": false
    }
  },
  "message": "Console session running.",
  "result": "success",
  "version": "2.4.0"
}

From Command line terminal

1
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/serial/status/<console name: optional>/'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/console/serial/status/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": {
    "dut_number": 1,
    "isActive": true,
    "status": {
         "serial0": true,
         "serial1": false,
         "serial2": false,
         "serial3": true,
         "serial4": false,
         "serial5": false,
         "serial6": false,
         "serial7": false
    }
  },
  "message": "Console session running.",
  "result": "success",
  "version": "2.4.0"
}

Device SSH Console

Upload

From Command line terminal

1
2
3
4
5
6
 curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/upload/ssh/' \
        --header 'Authorization: token {Authorization token}' \
        --form 'file=@"{File Path}"' \
        --form 'path="{Upload Path}"' \
        --form 'username="{SSH Username}"' \
        --form 'device_ip="{Device IP Address}"'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/upload/ssh/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
     --form 'file=@"/home/hbansal/Isos/BBB/MLO"' \
     --form 'path="/root"' \
     --form 'username="root"' \
     --form 'device_ip="192.168.111.13"'

{
    "message": "MLO uploaded",
    "result": "success",
    "version": "2.4.0"
}

Download

From Command line terminal

1
2
3
4
 curl --location --request GET \
         'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/download/ssh?path={File path to download}&device_ip={Device IP Address}&username={Device SSH Username}' \
        --header 'Authorization: token {Authorization token}' \
        --output '{Saved file}'

Example:

1
2
3
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/download/ssh?path=/root/test.txt&device_ip=192.168.111.13&username=root' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
     --output 'test.txt'

Run Command

From Command line terminal

1
2
3
 curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/run/ssh/' \
        --header 'Authorization: token {Authorization token}' --header 'Content-Type: application/json' \
        --data-raw '{"command": "{Command}", "device_ip": "{Device IP Address}", "username": "{Device Username}"}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/run/ssh/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
     --header 'Content-Type: application/json' --form --data-raw ''{"command": "whoami","device_ip": "192.168.111.13","username": "root"}''

{
    "data": {
        "data": [
            "root\n"
        ],
        "return_code": 0
    },
    "result": "success",
    "version": "2.4.0"
}

Import SSH Key

From Command line terminal

1
2
3
4
5
 curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/import/key/ssh/' \
        --header 'Authorization: token {Authorization token}' \
        --form 'username="{SSH Username}"' \
        --form 'password="{SSH Password}"' \
        --form 'device_ip="{Device IP Address}"'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/import/key/ssh/' \
     --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq' \
     --form 'device_ip="192.168.111.13"' \
     --form 'username="root"' \
     --form 'password="root"'

{
    "message": "",
    "result": "success",
    "version": "2.4.0"
}

Hotplugs

Status

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/hotplug/<hotplug number (1-4)>/

Example:

1
2
3
4
5
6
7
https://172.16.3.21/api/v0.2/devices/bbb_demo/hotplug/1/

{
  "data": "on",
  "result": "success",
  "version": "2.4.0"
}

From Command line terminal

1
2
 curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/hotplug/<hotplug number (1-4)>/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/hotplug/1/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "on",
  "result": "success",
  "version": "2.4.0"
}

ON

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/hotplug/<hotplug number (1-4)>/on/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/hotplug/1/on/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "on",
  "result": "success",
  "version": "2.4.0"
}

OFF

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/hotplug/<hotplug number (1-4)>/off/'  \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/hotplug/1/off/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "off",
  "result": "success",
  "version": "2.4.0"
}

Switch

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/hotplug/<hotplug number (1-4)>/switch/'
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/hotplug/1/switch/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "off",
  "result": "success",
  "version": "2.4.0"
}

SDMux

Status

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdmux/

Example:

1
2
3
4
5
6
7
https://172.16.3.21/api/v0.2/devices/bbb_demo/sdmux/

{
  "data": "device",
  "result": "success",
  "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdmux/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdmux/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "device",
  "result": "success",
  "version": "2.4.0"
}

Switch

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdmux/switch/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdmux/switch/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "zombie",
  "result": "success",
  "version": "2.4.0"
}

Switch-Zombie

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdmux/switch/zombie/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdmux/switch/zombie/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "zombie",
  "result": "success"
}

Switch-Device

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdmux/device/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdmux/device/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": "device",
  "result": "success"
}

USBMux

Status

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/usbmux/

Example:

1
2
3
4
5
6
7
https://172.16.3.21/api/v0.2/devices/bbb_demo/usbmux/

{
  "result": "success",
  "data": "zombie",
  "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/usbmux/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/usbmux/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "zombie",
  "version": "2.4.0"
}

Switch

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/usbmux/switch' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
9
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/usbmux/switch' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "device",
  "hp_num": 1,
  "version": "2.4.0"
}

Switch-Zombie

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/<device name>/usbmux/switch/zombie' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
9
curl --location --request PUT 'https://172.16.3.21/api/bbb_demo/usbmux/switch/zombie' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "zombie",
  "hp_num": 1,
  "version": "2.4.0"
}

Switch-Device

From Command line terminal

1
2
curl --location --request PUT 'https://{EBF Server IP Address}/api/<device name>/usbmux/switch/device' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
9
curl --location --request PUT 'https://172.16.3.21/api/bbb_demo/usbmux/switch/device' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": "device",
  "hp_num": 1,
  "version": "2.4.0"
}

SDCard

Info

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/info

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/info

{
    "result": "success",
    "data": {
        "partitions": [
            {
                "start_sector": "2048",
                "fstype": "vfat",
                "dev": "sdb1",
                "size": "100M",
                "bootable": true,
                "label": "boot",
                "type": "part"
            },
            {
                "start_sector": "206848",
                "fstype": "ext4",
                "dev": "sdb2",
                "size": "6.9G",
                "bootable": false,
                "label": "",
                "type": "part"
            }
        ],
        "fdisk": [
            "",
            "Disk /dev/sdb: 7.4 GiB, 7948206080 bytes, 15523840 sectors",
            "Units: sectors of 1 * 512 = 512 bytes",
            "Sector size (logical/physical): 512 bytes / 512 bytes",
            "I/O size (minimum/optimal): 512 bytes / 512 bytes",
            "Disklabel type: dos",
            "Disk identifier: 0x0d7da0a4",
            "",
            "Device     Boot  Start      End  Sectors  Size Id Type",
            "/dev/sdb1  *      2048   206847   204800  100M  c W95 FAT32 (LBA)",
            "/dev/sdb2       206848 14542847 14336000  6.9G 83 Linux",
            "",
            ""
        ],
        "total_size": "7.4G",
        "device": "sdb"
    },
    "version": "2.4.0"

}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/info' \
      --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/info/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "data": {
    "partitions": [
      {
        "start_sector": "2048",
        "fstype": "vfat",
        "dev": "sdb1",
        "size": "100M",
        "type": "part",
        "label": "boot",
        "bootable": true
      },
      {
        "start_sector": "206848",
        "fstype": "ext4",
        "dev": "sdb2",
        "size": "6.9G",
        "type": "part",
        "label": "",
        "bootable": false
      }
    ],
    "fdisk": [
      "",
      "Disk /dev/sdb: 7.4 GiB, 7948206080 bytes, 15523840 sectors",
      "Units: sectors of 1 * 512 = 512 bytes",
      "Sector size (logical/physical): 512 bytes / 512 bytes",
      "I/O size (minimum/optimal): 512 bytes / 512 bytes",
      "Disklabel type: dos",
      "Disk identifier: 0x0d7da0a4",
      "",
      "Device     Boot  Start      End  Sectors  Size Id Type",
      "/dev/sdb1  *      2048   206847   204800  100M  c W95 FAT32 (LBA)",
      "/dev/sdb2       206848 14542847 14336000  6.9G 83 Linux",
      "",
      ""
    ],
    "total_size": "7.4G",
    "device": "sdb"
  },
  "version": "2.4.0"
}

Mount

From Command line terminal

1
2
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/mount' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/mount/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "result": "success",
  "version": "2.4.0"
}

Format

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/format' \
      --header 'Authorization: token {Authorization token}' \
      --data-raw '{"format": [{"partition": "{partition name}","type": "{partition type}"}]}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/format/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --data-raw '{"format": [{"partition": "sda1","type": "vfat"},{"partition": "sda2","type": "ext4"}]}'

{
    "result": "success",
    "version": "2.4.0"
}

Partition

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/partition' \
      --header 'Authorization: token {Authorization token}' /
      --data-raw '{"partitions": [{"label": "{partition name}","size": "{partition size}","type": "{partition type}"}]}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/partition/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --data-raw '{"partitions": [{"label": "boot","size": "64","type": "vfat"},{"label": "rfs","size": "2048","type": "ext4"}]}'

{
    "result": "success",
    "version": "2.4.0"
}

Flash File

From Local Computer

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/flash' \
        --header 'Authorization: token {Authorization token}' \
        --form 'file=@{File Path}' --form 'partition={Device partition}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/sdcard/flash/' \
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq'
       --form 'file=@/home/hbansal/Isos/BBB/bbb_minimal_ll_orig.img.gz' --form 'partition=sda'

{
   "result": "success",
   "data": {
    "job_id": "b33bd7db-1065-41c3-b27a-a059f3734de1",
    "progress_url": "https://172.16.30.138/api/v0.2/devices/bbb01/sdcard/flash/status/b33bd7db-1065-41c3-b27a-a059f3734de1/"
   },
   "version": "2.4.0"
}

From EBF Server

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/flash' \
     --header 'Authorization: token {Authorization token}' \
     --header 'Content-Type: application/json' --data-raw '{"file": "{File Name}", "partition": "{Device partition}"}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/sdcard/flash/' \
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq' \
       --header 'Content-Type: application/json' --data-raw '{"file": "bbb_minimal_ll_orig.img.gz", "partition": "sda"}'

{
  "result":"success",
  "data":{
      "job_id":"b33bd7db-1065-41c3-b27a-a059f3734de1",
      "progress_url":"https://172.16.30.138/api/v0.2/devices/bbb01/sdcard/flash/status/b33bd7db-1065-41c3-b27a-a059f3734de1/"
   },
   "version": "2.4.0"
}

Check Flash File Status

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/flash/status/{Job Id}' \
        --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
curl --location --request GET 'https://172.16.30.138/api/v0.2/devices/bbb01/sdcard/flash/status/a825c7c0-3e36-4f4f-833a-af565ecd155b/'
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq'

{
  "result":"success",
  "data":{
      "status":"started",
       "info":{
          "progress":11,
          "file_size":2147483648,
          "storage_size_check":"done",
          "file_size_check":"done",
          "flash":"running",
          "current":"Flashing File",
          "file_name":"bbb_minimal_ll_orig.img.gz","partition":"sda"
        }
   },
  "version": "2.4.0"
}

USB

Flash File

From Local Computer

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/usb/flash' \
        --header 'Authorization: token {Authorization token}' \
        --form 'file=@{File Path}' --form 'partition={Device partition}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/usb/flash/' \
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq'
       --form 'file=@/home/hbansal/Isos/BBB/bbb_minimal_ll_orig.img.gz' --form 'partition=sda'

{
  "result":"success",
  "data":{
      "job_id":"b33bd7db-1065-41c3-b27a-a059f3734de1",
      "progress_url":"https://172.16.30.138/api/v0.2/devices/bbb01/usb/flash/status/b33bd7db-1065-41c3-b27a-a059f3734de1/"
   },
  "version": "2.4.0"
}

From EBF Server

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/usb/flash' \
        --header 'Authorization: token {Authorization token}' \
        --header 'Content-Type: application/json' --data-raw '{"file": "{File Name}", "partition": "{Device partition}"}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/usb/flash/' \
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq' \
       --header 'Content-Type: application/json' --data-raw '{"file": "bbb_minimal_ll_orig.img.gz", "partition": "sda"}'

{
  "result":"success",
  "data":{
      "job_id":"b33bd7db-1065-41c3-b27a-a059f3734de1",
      "progress_url":"https://172.16.30.138/api/v0.2/devices/bbb01/usb/flash/status/b33bd7db-1065-41c3-b27a-a059f3734de1/"
   },
  "version": "2.4.0"
}

Check Flash File Status

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/usb/flash/status/{Job Id}' \
        --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
curl --location --request GET 'https://172.16.30.138/api/v0.2/devices/bbb01/usb/flash/status/a825c7c0-3e36-4f4f-833a-af565ecd155b/'
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq'

{
  "result":"success",
  "data":{
      "status":"started",
       "info":{
          "progress":11,
          "file_size":2147483648,
          "storage_size_check":"done",
          "file_size_check":"done",
          "flash":"running",
          "current":"Flashing File",
          "file_name":"bbb_minimal_ll_orig.img.gz","partition":"sda"
        }
   },
  "version": "2.4.0"
}

Network Boot

Transfer File

From Local Computer

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/transfer/file/' \
        --header 'Authorization: token {Authorization token}' \
        --form 'file=@{File Path}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/netboot/transfer/file/' \
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq'
       --form 'file=@/home/hbansal/Isos/BBB/rootfs-bbb.tar.gz'

{
  "result":"success",
  "data":{
      "job_id":"b33bd7db-1065-41c3-b27a-a059f3734de1",
      "progress_url":"https://172.16.30.138/api/v0.2/devices/bbb01/netboot/transfer/file/status/b33bd7db-1065-41c3-b27a-a059f3734de1/"
   },
  "version": "2.4.0"
}

From EBF Server

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/transfer/file/' \
        --header 'Authorization: token {Authorization token}' \
        --header 'Content-Type: application/json' --data-raw '{"file": "{File Name}"}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --location --request POST 'https://172.16.30.138/api/v0.2/devices/bbb01/netboot/transfer/file/' \
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq' \
       --header 'Content-Type: application/json' --data-raw '{"file": "rootfs-bbb.tar.gz"}'

{
  "result":"success",
  "data":{
      "job_id":"b33bd7db-1065-41c3-b27a-a059f3734de1",
      "progress_url":"https://172.16.30.138/api/v0.2/devices/bbb01/netboot/transfer/file/status/b33bd7db-1065-41c3-b27a-a059f3734de1/"
   },
  "version": "2.4.0"
}

Check Transfer File Status

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/transfer/file/status/{Job Id}' \
        --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
curl --location --request GET 'https://172.16.30.138/api/v0.2/devices/bbb01/netboot/transfer/file/status/a825c7c0-3e36-4f4f-833a-af565ecd155b/'
       --header 'Authorization: token 3ywmgwdt2hm7uwn79104e6rctkhm1x5tgzssrbthhcgajg8ja1i3uxu3ypwpjys060s0mfzm9z6yk91nkwiodcpn1fyeytrk2li27mqyoqg3dafcifnta1l35h6c18bq'

{
  "result":"success",
  "data":{
            "status":"started",
             "info":{
                      "progress":11,
                      "file_size":2147483648,
                      "storage_size_check":"done",
                      "file_size_check":"done",
                      "flash":"running",
                      "current":"Flashing File",
                      "file_name":"rootfs-bbb.tar.gz"
                    }
         },
  "version": "2.4.0"
}

Generate Boot-menu

Kernel only

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/bootmenu/' \
        --header 'Authorization: token {Authorization token}' \
        --header 'Content-Type: application/json' --data-raw '{"kernel": "<kernel path>"}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.30.140/api/v0.2/devices/dev1/netboot/bootmenu/' \
   --header 'Authorization: token rdn10oyatbcjch54d3hz3lxxs9j49f3olc880ii8u4rahaqwjswc8p58aznlw20xdig0770z005lw30qb3rk1ui08u5a3002blw890l2c5x6whe50ceb06ropfjixp0x' \
   --header 'Content-Type: application/json' --data-raw '{"kernel": "kernel"}'

{
  "result":"success",
  "version": "2.4.0"
}

Kernel and Initrd

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/bootmenu/' \
        --header 'Authorization: token {Authorization token}' \
        --header 'Content-Type: application/json' --data-raw '{"kernel": "<kernel path>", "initrd": "<initrd path>"}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.30.140/api/v0.2/devices/dev1/netboot/bootmenu/' \
   --header 'Authorization: token rdn10oyatbcjch54d3hz3lxxs9j49f3olc880ii8u4rahaqwjswc8p58aznlw20xdig0770z005lw30qb3rk1ui08u5a3002blw890l2c5x6whe50ceb06ropfjixp0x' \
   --header 'Content-Type: application/json' --data-raw '{"kernel": "kernel", "initrd": "ramdisk.img"}'

{
  "result":"success",
  "version": "2.4.0"
}

SDCard File manager

List

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/fmanager/<path: optional>/

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/sdb1/

{
  "data": [
    {
      "file_or_dir_name": "MLO",
      "modified_date": "Jan 22, 2021 12:50:42 PM",
      "owner": "root",
      "size": "108K",
      "symlink_target": "",
      "type": "File"
    }
  ],
  "result": "success",
  "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/fmanager/<path: optional>/' \
      --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/sdb1/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": [
    {
      "file_or_dir_name": "MLO",
      "modified_date": "Jan 22, 2021 12:50:42 PM",
      "owner": "root",
      "size": "108K",
      "symlink_target": "",
      "type": "File"
    }
  ],
  "result": "success",
  "version": "2.4.0"
}

Create Directory

From Command line terminal

1
2
curl --location --request POST 'https://{EBF Server IP Address}/sdcard/fmanager/dir/<path>/' \
   --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/dir/sdb1/test/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
   "message":"sdb1/test  created",
   "result":"success",
   "version": "2.4.0"
}

Delete Directory

From Command line terminal

1
2
curl --location --request DELETE 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/fmanager/dir/<path>/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request DELETE 'hhttps://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/dir/sdb1/test/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
   "message":"sdb1/test  deleted",
   "result":"success"
   "version": "2.4.0",
}

Upload Files

From Command line terminal

1
2
3
4
curl --location --request PUT 'https://{EBF Server IP Address/api/v0.2/devices/<device name>/sdcard/fmanager/dir/' \
      --header 'Authorization: token {Authorization token}' \
      --form 'file=@"<Upload file>"' \
      --form 'path_to_upload_file="<upload path>"'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/dir/sdb1/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --form 'file=@"/home/timesys/QNX"' \
      --form 'path_to_upload_file="sdb1/"'

{
   "message":"100% upload completed.",
   "result":"success",
   "version": "2.4.0"
}

Download Files

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/sdcard/fmanager/dir/<path>/

Example:

1
https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/download/sdb1/MLO

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address/api/v0.2/devices/<device name>/sdcard/fmanager/dir/<path>/' \
      --header 'Authorization: token {Authorization token}' --output <path/filename>

Example:

1
2
3
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/sdcard/fmanager/dir/sdb1/MLO' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --output /home/timesys/Desktop/MLO

Network Boot File Manager

List

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/<path: optional>/

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/

{
    "data": [
        {
            "file_or_dir_name": "fsroot",
            "modified_date": "Jan 21, 2021 05:32:08 PM",
            "owner": "root",
            "size": "47",
            "symlink_target": "-> my_rootfs",
            "type": "Directory"
        },
        {
            "file_or_dir_name": "my_rootfs",
            "modified_date": "Jan 21, 2021 05:32:08 PM",
            "owner": "root",
            "size": "4.0K",
            "symlink_target": "",
            "type": "Directory"
        },
        {
            "file_or_dir_name": "qnx",
            "modified_date": "Jan 22, 2021 11:26:12 AM",
            "owner": "root",
            "size": "4.0K",
            "symlink_target": "",
            "type": "Directory"
        },
        {
            "file_or_dir_name": "beaglebone_black.dtb",
            "modified_date": "Jan 21, 2021 04:33:40 PM",
            "owner": "root",
            "size": "36K",
            "symlink_target": "",
            "type": "File"
        },
        {
            "file_or_dir_name": "uImage-4.14-ts-armv7l",
            "modified_date": "Jan 21, 2021 05:46:23 PM",
            "owner": "root",
            "size": "5.0M",
            "symlink_target": "",
            "type": "File"
        }
    ],
    "result": "success",
    "version": "2.4.0"
}

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/<path: optional>/' \
      --header 'Authorization: token {Authorization token}'

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
  "data": [
    {
      "file_or_dir_name": "fsroot",
      "modified_date": "Jan 21, 2021 05:32:08 PM",
      "owner": "root",
      "size": "47",
      "symlink_target": "-> my_rootfs",
      "type": "Directory"
    },
    {
      "file_or_dir_name": "my_rootfs",
      "modified_date": "Jan 21, 2021 05:32:08 PM",
      "owner": "root",
      "size": "4.0K",
      "symlink_target": "",
      "type": "Directory"
    },
    {
      "file_or_dir_name": "qnx",
      "modified_date": "Jan 22, 2021 11:26:12 AM",
      "owner": "root",
      "size": "4.0K",
      "symlink_target": "",
      "type": "Directory"
    },
    {
      "file_or_dir_name": "beaglebone_black.dtb",
      "modified_date": "Jan 21, 2021 04:33:40 PM",
      "owner": "root",
      "size": "36K",
      "symlink_target": "",
      "type": "File"
    },
    {
      "file_or_dir_name": "uImage-4.14-ts-armv7l",
      "modified_date": "Jan 21, 2021 05:46:23 PM",
      "owner": "root",
      "size": "5.0M",
      "symlink_target": "",
      "type": "File"
    }
  ],
  "result": "success",
  "version": "2.4.0"
}

Create Directory

From Command line terminal

1
2
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/dir/<path>/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/dir/test/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
   "message":"test  created",
   "result":"success",
   "version": "2.4.0"
}

Delete File / Directory

From Command line terminal

1
2
curl --location --request DELETE 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/dir/<path>/'
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request DELETE 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/dir/test/'
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
   "message":"test  deleted",
   "result":"success",
   "version": "2.4.0"
}

upload files

From Command line terminal

1
2
3
4
5
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/dir/{upload path}' \
      --header 'Authorization: token {Authorization token}' \
      --form file=@{file path} \
      --form path_to_upload_file={upload file path} \
      --form file_rename={true/false}

Examples:

Upload file

1
2
3
4
5
6
7
8
9
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/dir/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --form 'file=@"/home/timesys/screenshot.png"' \
      --form 'path_to_upload_file="qnx/"'

{
   "message":"100% upload completed.",
   "result":"success"
}

OR

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/dir/qnx/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --form 'file=@"/home/timesys/screenshot.png"' \

{
   "message":"100% upload completed.",
   "result":"success"
}

Upload and rename file

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/dir/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --form 'file=@"/home/timesys/screenshot.png"' \
      --form 'path_to_upload_file="qnx/myscreenshot.png"' \
      --form 'file_rename=true'

{
   "message":"100% upload completed.",
   "result":"success"
}

OR

1
2
3
4
5
6
7
8
9
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/dir/qnx/myscreenshot.png/' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --form 'file=@"/home/timesys/screenshot.png"' \
      --form 'file_rename=true'

{
   "message":"100% upload completed.",
   "result":"success"
}

Download files

From Web browser:

1
https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/download/<path>/

Example:

1
https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/download/qnx/sshd_config

From Command line terminal

1
2
3
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/netboot/fmanager/download/<path>/'  \
      --header 'Authorization: token {Authorization token}' \
      --output <path/filename>

Example:

1
2
3
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/netboot/fmanager/download/qnx/sshd_config' \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --output /home/timesys/Desktop/MLO

Port Forwarding

Add Port

From Command line terminal

1
2
3
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/portfw/nat/' \
      --header 'Authorization: token {Authorization token}' \
      --data-raw '{"device_ip": "<device_ip>","dut_port": <device port to forward>,"zombie_port": <zombie port>,"pcol":"<protocol>"}'

Example:

1
2
3
4
5
6
7
8
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/portfw/nat/ \
         --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
         --data-raw '{"device_ip": "192.168.111.19","dut_port": 22,"zombie_port": 1491,"pcol":"tcp"}'

{
   "result": "success",
   "version": "2.4.0"
}

Remove Port

From Command line terminal

1
2
3
curl --location --request DELETE 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/portfw/nat/' \
      --header 'Authorization: token {Authorization token}' \
      --data-raw '{"device_ip": "<device_ip>","dut_port": <device port to forward>,"zombie_port": <zombie port>,"pcol":"<protocol>"}'

Example:

1
2
3
4
5
6
7
8
curl --location --request DELETE 'https://172.16.3.21/api/v0.2/devices/bbb_demo/portfw/nat/ \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
         --data-raw '{"device_ip": "192.168.111.19","dut_port": 22,"zombie_port": 1491,"pcol":"tcp"}'

{
   "result": "success",
   "version": "2.4.0"
}

Restore Port

From Command line terminal

1
2
3
curl --location --request PUT 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/portfw/nat/' \
      --header 'Authorization: token {Authorization token}' \
      --data-raw '{"device_ip": "<device_ip>","dut_port": <device port to forward>,"zombie_port": <zombie port>,"pcol":"<protocol>"}'

Example:

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://172.16.3.21/api/v0.2/devices/bbb_demo/portfw/nat/ \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0' \
      --data-raw '{"device_ip": "192.168.111.19","dut_port": 22,"zombie_port": 1491,"pcol":"tcp"}'

{
   "result": "success",
   "version": "2.4.0"
}

WEB CAM

Restart-feed

From Command line terminal

1
2
curl --location --request POST 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/webcam/restartfeed/' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request POST 'https://172.16.3.21/api/v0.2/devices/bbb_demo/webcam/restartfeed/ \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
   "result": "success",
   "version": "2.4.0"
}

Image Capture

From Command line terminal

1
2
curl --location --request GET 'https://{EBF Server IP Address}/api/v0.2/devices/<device name>/image/capture/' \
      --header 'Authorization: token {Authorization token}

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.3.21/api/v0.2/devices/bbb_demo/image/capture/ \
      --header 'Authorization: token e463u9334siny819ybsk3x5hxxj0hps01h3lk35fkh5qdnyqkptmw2aewboo3m86ljawaig0t42elzbb131iptpe2dqkbf39tltcnfmtdm0qin8mw00a9uwljrm4shr0'

{
   "status": "success",
   "data": "https://172.16.99.105/icamImages/2021-01-25_084945.jpg",
   "version": "2.4.0"
}

Download Console Logs

From Command line terminal

1
2
curl --location --request GET https://{EBF Server IP Address}/api/v0.2/devices/<device name>/console/logs/download/<console name: optional> \
      --header 'Authorization: token {Authorization token}

Example:

download from first console

1
2
3
4
5
6
7
curl --location --request GET https://172.16.30.247/api/v0.2/devices/EBF_Build_Rpi3/console/logs/download \
      --header 'Authorization: token a6nhx3rep1jfbhwimfp847pu55n4n3fbh64u1yxn2kz8t9mbumuc8bjjf9bgegjqly54y11kha0ui11zkt2m1d4wzgikanmwswtg1l0u5j7060i1pohjts122jslwu1j' \
      --output EBF_Build_Rpi3-2310271529.logs

{
   "download": "Successfully Downloaded console logs to "EBF_Build_Rpi3-1-2310271529.logs"
}

download from Nth console

1
2
3
4
5
6
7
curl --location --request GET https://172.16.30.247/api/v0.2/devices/EBF_Build_Rpi3/console/logs/download/serial0/ \
      --header 'Authorization: token a6nhx3rep1jfbhwimfp847pu55n4n3fbh64u1yxn2kz8t9mbumuc8bjjf9bgegjqly54y11kha0ui11zkt2m1d4wzgikanmwswtg1l0u5j7060i1pohjts122jslwu1j' \
      --output EBF_Build_Rpi3-2310271529.logs

{
   "download": "Successfully Downloaded console logs to "EBF_Build_Rpi3-4-2310271529.logs"
}

GPIO

GPIO Pins Hardware setup

  1. The following image shows how User GPIO pins are setup. These GPIO pins are in the pair of PIN-GROUND format. The following image representation is for Pins 1 to 6.
_images/GPIOiocxSetup.jpeg
  1. To set up I2C GPIO pins, see the following image. The following image representation is for Pins 7 and 8. These Pins are connected to the I2C bus on first and third pins, starting from the left.
_images/GPIOi2cSetup.jpeg

From Command line terminal:

1
curl -k https://{Master IP Address}/api/<devicename>/gpio/<command>/<gpio_pin_pattern>/<gpio_pin_data>

Here’s a table overview of the commands, arguments, and inputs and outputs:

Commands gpio_pin_pattern gpio_pin_data output
set_mode_mask 1-255 0-255 Current GPIO pin modes as dec (0-255)
get_mode_mask 1-255   Current GPIO pin modes as dec (0-255)
set_mode 1-8 {read,write} Current GPIO pin modes as dec (0-255)
get_mode 1-8   Current GPIO pin mode as string (read,write)
read_mask 1-255   Current GPIO values as dec (0-255)
write_mask 1-255 0-255 Current GPIO values as dec (0-255)
read 1-8   Current GPIO value as bin (0-1)
write 1-8 0-1 Current GPIO value as bin (0-1)|

Any value listed as either 0-255 or 1-255 is a decimal representation of the GPIO input or output bytes. The ‘mode’ arguments refer to input (write) or output (read). For the outputs, 0 is considered ‘write’, and 1 is considered ‘read’.

Example:

1
2
3
4
5
6
curl --location --request GET 'https://172.16.30.11/api/bbb_demo/gpio/get_mode/6'

{
   "result": "success",
   "data": "write"
}

RESOURCE

Get Resource

1
2
curl --location --request GET https://{EBF Server IP Address}/api/v0.2/devices/{DeviceName}/get-resource/{Resource-Type}/ \
      --header 'Authorization: token {Authorization token}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request GET https://bfc.timesys.com/api/v0.2/devices/rpi3-2/get-resource/power-measurement \
      --header 'Authorization: token 27gy0kmr0ak2650zu09e6azda0255gofjkpl8qyks4cuh5ukifyh4o45ypp1nm3q7klo1kzx8to6jf5dicewot15eirctf0ll4uk47yd15sd11qfdgxokda9sy0i70xr'

{
   "result":"success",
   "data":{
      "resource_name":"ACME1"
   },
   "version": "2.4.0"
}

Power Management

Start Capture

1
2
curl --location --request POST https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/power-measurement/start-capture/ \
      --header 'Authorization: token {Authorization token}

1
2
3
4
5
6
7
8
curl --location --request POST https://bfc.timesys.com/api/v0.2/resources/ACME1/power-measurement/start-capture/ \
      --header 'Authorization: token 27gy0kmr0ak2650zu09e6azda0255gofjkpl8qyks4cuh5ukifyh4o45ypp1nm3q7klo1kzx8to6jf5dicewot15eirctf0ll4uk47yd15sd11qfdgxokda9sy0i70xr'

{
   "result": "success",
   "data": 1639552930,
   "version": "2.4.0"
}

Stop Capture

1
2
curl --location --request PUT https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/power-measurement/stop-capture/{token} \
      --header 'Authorization: token {Authorization token}

1
2
3
4
5
6
7
curl --location --request PUT https://bfc.timesys.com/api/v0.2/resources/ACME1/power-measurement/stop-capture/1639552930 \
      --header 'Authorization: token 27gy0kmr0ak2650zu09e6azda0255gofjkpl8qyks4cuh5ukifyh4o45ypp1nm3q7klo1kzx8to6jf5dicewot15eirctf0ll4uk47yd15sd11qfdgxokda9sy0i70xr'

{
   "result": "success",
   "version": "2.4.0"
}

Get Data

1
2
curl --location --request GET https://{EBF Server IP Address}//api/v0.2/resources/{ResourceName}/power-measurement/get-data/{token} \
      --header 'Authorization: token {Authorization token}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
curl --location --request GET https://bfc.timesys.com/api/v0.2/resources/ACME1/power-measurement/get-data/1639552930 \
      --header 'Authorization: token 27gy0kmr0ak2650zu09e6azda0255gofjkpl8qyks4cuh5ukifyh4o45ypp1nm3q7klo1kzx8to6jf5dicewot15eirctf0ll4uk47yd15sd11qfdgxokda9sy0i70xr'

{
   "result": "success",
   "data": "timestamp,voltage,current
            1572709715,5136.200,350.768
            1572709716,5136.218,350.751
            1572709717,5136.184,350.972
            1572709718,5136.185,350.937
            1572709719,5136.204,350.909
            1572709720,5136.208,350.870
            1572709721,5136.192,350.959
            1572709722,5136.200,350.924",
   "version": "2.4.0"
}

Delete Data

1
curl --location --request DELETE https://{EBF Server IP Address}//api/v0.2/resources/{ResourceName}/power-measurement/delete/{token}

1
2
3
4
5
6
7
curl --location --request DELETE https://bfc.timesys.com/api/v0.2/resources/ACME1/power-measurement/delete/1639552930 \
      --header 'Authorization: token 27gy0kmr0ak2650zu09e6azda0255gofjkpl8qyks4cuh5ukifyh4o45ypp1nm3q7klo1kzx8to6jf5dicewot15eirctf0ll4uk47yd15sd11qfdgxokda9sy0i70xr'

{
   "result": "success",
   "version": "2.4.0"
}

CAMERA

Capture Still Image

1
2
curl --location --request GET https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/camera/capture/ \
      --header 'Authorization: token {Authorization token}

1
2
3
4
5
6
7
8
curl --location --request GET https://172.16.30.245/api/v0.2/resources/CAM1/camera/capture \
      --header 'Authorization: token b2yykdx0g1wg3iklrhhmkaz0i73paj3jt10yasz1is93mop8k3gt69rwn1mpihmuo7l7jkk62354l0sucqfpqqybablz3yx9d2bklckr0y5307cbfxsd0qj6jrkxkhpn'

{
   "result":"success",
   "data":"https://172.16.30.245/camera/rpi_test-2022-06-23_073947.jpg",
   "version": "2.4.0"
}

AUDIO

Start

1
2
curl --location --request POST https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/audio/start-capture/ \
      --header 'Authorization: token {Authorization token}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request POST https://172.16.30.245/api/v0.2/resources/AUDIO1/audio/start-capture/ \
      --header 'Authorization: token b2yykdx0g1wg3iklrhhmkaz0i73paj3jt10yasz1is93mop8k3gt69rwn1mpihmuo7l7jkk62354l0sucqfpqqybablz3yx9d2bklckr0y5307cbfxsd0qj6jrkxkhpn'

{
   "data":{
      "token":"33cf89d4741e4fccb892c2d23d73ad1b"
      },
   "result":"success",
   "version": "2.4.0"
}

Stop

1
2
curl --location --request PUT https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/audio/stop-capture/{AudioID} \
      --header 'Authorization: token {Authorization token}

1
2
3
4
5
6
7
curl --location --request PUT https://172.16.30.245/api/v0.2/resources/AUDIO1/audio/stop-capture/b414e732b09843af8a7db1c32dbcdd23 \
      --header 'Authorization: token b2yykdx0g1wg3iklrhhmkaz0i73paj3jt10yasz1is93mop8k3gt69rwn1mpihmuo7l7jkk62354l0sucqfpqqybablz3yx9d2bklckr0y5307cbfxsd0qj6jrkxkhpn'

{
   "result":"success",
   "version": "2.4.0"
}

Get-reference

1
2
curl --location --request GET https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/audio/get-ref/{AudioID} \
      --header 'Authorization: token {Authorization token}

1
2
3
4
5
6
7
8
curl --location --request GET https://172.16.30.245/api/v0.2/resources/AUDIO1/audio/get-ref/5159e4f233a9442cb623da1120cd2bfb \
      --header 'Authorization: token b2yykdx0g1wg3iklrhhmkaz0i73paj3jt10yasz1is93mop8k3gt69rwn1mpihmuo7l7jkk62354l0sucqfpqqybablz3yx9d2bklckr0y5307cbfxsd0qj6jrkxkhpn'

{
   "result":"success",
   "data":"https://172.16.30.245/audio/test-5159e4f233a9442cb623da1120cd2bfb.wmv",
   "version": "2.4.0"
}

Delete

1
2
curl --location --request DELETE https://{EBF Server IP Address}/api/v0.2/resources/{ResourceName}/audio/delete/{AudioID} \
      --header 'Authorization: token {Authorization token}

1
2
3
4
5
6
7
curl --location --request DELETE https://172.16.30.245/api/v0.2/resources/AUDIO1/audio/delete/5159e4f233a9442cb623da1120cd2bfb \
      --header 'Authorization: token b2yykdx0g1wg3iklrhhmkaz0i73paj3jt10yasz1is93mop8k3gt69rwn1mpihmuo7l7jkk62354l0sucqfpqqybablz3yx9d2bklckr0y5307cbfxsd0qj6jrkxkhpn'

{
   "result":"success",
   "version": "2.4.0"
}

Delete Zombie

From Command line terminal

1
2
curl --location --request DELETE  https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01 \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
curl --location --request DELETE https://172.16.7.21/api/v0.2/zombies/DelhiTimesysZombie01 \
      --header 'Authorization: token 22nbjxec52gxfpz32t82cqb7twfk9b2llrlaxfm2jl4ftkfhnxylyidsae260ajqfp2lk3r0l02crugak42yoy7tt90sn4flo20zt13ibuc0yfnb0xjgxsg3tcry33am'

{
   "result":"success",
   "version": "2.4.0"
}

Search/Allocate Devices

From Web browser:

1
https://172.16.30.253/api/v0.2/devices/description

Example:

1
2
3
4
5
https://172.16.30.253/api/v0.2/devices/description__startswith=d

{
    "result": "success"
}

From Command line terminal

1
2
curl --location --request GET 'https://172.16.30.253/api/v0.2/devices/?description__startswith=d' \
      --header 'Authorization: token {Authorization token}'

Example:

1
2
3
4
5
6
7
8
curl --location --request GET 'https://172.16.30.253/api/v0.2/devices/?description__startswith=d' \
      --header 'Authorization: token mks3wn3ddk3z5kym8jsehg9m09lflsn5hn4ef07tcylctddre8y98cjkratdo04roo2bd5h0s1810jqiub2nr0eig7t0o3ltceukiop3xo5ony4auh3n7bqydh4topt0'

{
   "result":"success",
   "data":["rpi-demo"],
   "version": "2.4.0"
}