Newer
Older
# swmodules Schema
```
https://dev.iopsys.eu/iopsys/swmodd/schemas/ubus/swmodules.json
```
| Custom Properties | Additional Properties |
| ----------------- | --------------------- |
| Forbidden | Forbidden |
# swmodules
| List of Methods |
| ----------------------------- |
| [du_install](#du_install) | Method | swmodules (this schema) |
| [du_list](#du_list) | Method | swmodules (this schema) |
| [du_uninstall](#du_uninstall) | Method | swmodules (this schema) |
| [du_update](#du_update) | Method | swmodules (this schema) |
| [ee_list](#ee_list) | Method | swmodules (this schema) |
| [ee_set_state](#ee_set_state) | Method | swmodules (this schema) |
| [eu_list](#eu_list) | Method | swmodules (this schema) |
| [eu_set_state](#eu_set_state) | Method | swmodules (this schema) |
## du_install
### Install new deployment units/packages into Execution environment
`du_install`
- type: `Method`
### du_install Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------ | ------------ |
| `input` | object | **Required** |
| `output` | object | Optional |
#### input
`input`
- is **required**
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| ---------- | ------- | ------------ |
| `ee_name` | string | Optional |
| `eeid` | integer | Optional |
| `password` | string | Optional |
| `url` | string | **Required** |
| `username` | string | Optional |
| `uuid` | string | Optional |
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#### password
`password`
- is optional
- type: `string`
##### password Type
`string`
#### url
`url`
- is **required**
- type: `string`
##### url Type
`string`
#### username
`username`
- is optional
- type: `string`
##### username Type
`string`
#### uuid
`uuid`
- is optional
- type: `string`
##### uuid Type
`string`
### Ubus CLI Example
```
ubus call swmodules du_install {"url":"mollit deserunt","uuid":"nulla aliquip eu","username":"amet exe","password":"velit voluptate enim ad in","ee_name":"sed quis","eeid":4}
```
### JSONRPC Example
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "call",
"params": [
"<SID>",
"swmodules",
"du_install",
{
"url": "mollit deserunt",
"uuid": "nulla aliquip eu",
"username": "amet exe",
"password": "velit voluptate enim ad in",
}
]
}
```
#### output
`output`
- is optional
- type: `object`
##### output Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------- | ------------ |
| `status` | boolean | **Required** |
#### status
`status`
- is **required**
- type: `boolean`
##### status Type
`boolean`
### Output Example
```json
```
## du_list
### Get list of deployment units (installed packages)
`du_list`
- type: `Method`
### du_list Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------ | -------- |
| `input` | object | Optional |
| `output` | | Optional |
#### input
`input`
- is optional
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| --------- | ------- | -------- |
| `ee_name` | string | Optional |
| `eeid` | integer | Optional |
ubus call swmodules du_list {"eeid":6,"ee_name":"quis exercitation nisi ullamco"}
{
"jsonrpc": "2.0",
"id": 0,
"method": "call",
"params": ["<SID>", "swmodules", "du_list", { "eeid": 6, "ee_name": "quis exercitation nisi ullamco" }]
```
#### output
`output`
- is optional
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": "string"
},
"type": "string"
},
"type": "integer",
"minimum": 1
},
"uuid": {
"type": "string"
},
"duid": {
"type": "string"
},
"url": {
"type": "string"
},
"version": {
"type": "string"
},
"config": {
"type": "string"
},
"description": {
"type": "string"
},
"vendor": {
"type": "string"
}
},
"required": ["du_name", "ee_name", "eeid", "uuid", "duid", "url", "version", "config", "description", "vendor"]
}
},
{
"type": "object",
"properties": {
"type": "array",
"items": []
}
}
"out": "{\"oneof\":[{\"deployment_unit\":[{\"du_name\":\"ea\",\"ee_name\":\"ullamco pariatur tempor\",\"uuid\":\"nostrud minim\",\"duid\":\"dolor in deserunt velit\",\"url\":\"Excepteur consequat\",\"version\":\"ut in nostrud nulla aliqu\",\"config\":\"qui\",\"description\":\"cillum ea incididunt pa\",\"vendor\":\"sed dolor\",\"eeid\":6}]},{\"deployment_unit\":[]}]}",
"simpletype": "complex"
}
```
### Output Example
```json
{
"du_name": "ea",
"ee_name": "ullamco pariatur tempor",
"uuid": "nostrud minim",
"duid": "dolor in deserunt velit",
"url": "Excepteur consequat",
"version": "ut in nostrud nulla aliqu",
"config": "qui",
"description": "cillum ea incididunt pa",
"vendor": "sed dolor",
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
]
}
```
## du_uninstall
### Uninstall installed deployment units/packages
`du_uninstall`
- type: `Method`
### du_uninstall Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------ | ------------ |
| `input` | object | **Required** |
| `output` | object | Optional |
#### input
`input`
- is **required**
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| --------- | ------- | ------------ |
| `du_name` | string | **Required** |
| `ee_name` | string | Optional |
| `eeid` | integer | Optional |
ubus call swmodules du_uninstall {"du_name":"est eiusmod culpa commodo","ee_name":"dolor ad","eeid":8}
```
### JSONRPC Example
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "call",
"params": [
"<SID>",
"swmodules",
"du_uninstall",
{ "du_name": "est eiusmod culpa commodo", "ee_name": "dolor ad", "eeid": 8 }
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
]
}
```
#### output
`output`
- is optional
- type: `object`
##### output Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------- | -------- |
| `status` | boolean | Optional |
#### status
`status`
- is optional
- type: `boolean`
##### status Type
`boolean`
### Output Example
```json
{ "status": true }
```
## du_update
### Update already installed deployment units
`du_update`
- type: `Method`
### du_update Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------ | ------------ |
| `input` | object | **Required** |
| `output` | object | Optional |
#### input
`input`
- is **required**
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| ---------- | ------- | ------------ |
| `ee_name` | string | Optional |
| `eeid` | integer | Optional |
| `password` | string | Optional |
| `url` | string | **Required** |
| `username` | string | Optional |
| `uuid` | string | **Required** |
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
#### password
`password`
- is optional
- type: `string`
##### password Type
`string`
#### url
`url`
- is **required**
- type: `string`
##### url Type
`string`
#### username
`username`
- is optional
- type: `string`
##### username Type
`string`
#### uuid
`uuid`
- is **required**
- type: `string`
##### uuid Type
`string`
### Ubus CLI Example
```
ubus call swmodules du_update {"url":"officia dolore eiusmod","uuid":"dolor sint","eeid":4,"ee_name":"sit amet ad","username":"aliqua non sit dolore sint","password":"Lorem in ut Duis"}
```
### JSONRPC Example
```json
{
"jsonrpc": "2.0",
"id": 0,
"method": "call",
"params": [
"<SID>",
"swmodules",
"du_update",
{
"url": "officia dolore eiusmod",
"uuid": "dolor sint",
"eeid": 4,
"ee_name": "sit amet ad",
"username": "aliqua non sit dolore sint",
"password": "Lorem in ut Duis"
}
]
}
```
#### output
`output`
- is optional
- type: `object`
##### output Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------- | ------------ |
| `status` | boolean | **Required** |
#### status
`status`
- is **required**
- type: `boolean`
##### status Type
`boolean`
### Output Example
```json
### Get list of available environments for software modules
`object` with following properties:
| Property | Type | Required |
| -------- | ------ | ------------ |
| `input` | object | Optional |
#### input
`input`
- is optional
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| -------- | ---- | -------- |
| None | None | None |
### Ubus CLI Example
```
{ "jsonrpc": "2.0", "id": 0, "method": "call", "params": ["<SID>", "swmodules", "ee_list", {}] }
```
#### output
`output`
- is **required**
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
"environment": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ee_name": {
"type": "string"
},
"eeid": {
"type": "integer"
},
"status": {
"type": "string"
},
"pause": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"autoboot": {
"type": "integer",
"minimum": 0,
"maximum": 1
},
"type": {
"type": "string"
},
"vendor": {
"type": "string"
},
"version": {
"type": "string"
},
"allocated_disk_space": {
"type": "integer",
"minimum": 0
},
"available_disk_space": {
"type": "integer",
"minimum": 0
},
"allocated_memory": {
"type": "integer",
"minimum": 0
},
"available_memory": {
"type": "integer",
"minimum": 0
},
"parent_ee_ref": {
"type": "integer",
"minimum": 0
}
},
"required": [
"ee_name",
"eeid",
"status",
"pause",
"autoboot",
"type",
"vendor",
"version",
"allocated_disk_space",
"available_disk_space",
"allocated_memory",
"available_memory",
"parent_ee_Ref"
]
}
]
}
},
{
"type": "object",
"properties": {
"environment": {
"type": "array",
"items": []
}
}
"out": "{\"oneof\":[{\"environment\":[{\"ee_name\":\"Lorem in aliquip ea elit\",\"eeid\":-21467911,\"status\":\"laboris mollit\",\"pause\":1,\"autoboot\":1,\"type\":\"ea\",\"vendor\":\"pariatur aliqua in dolo\",\"version\":\"dolore\",\"allocated_disk_space\":91843673,\"available_disk_space\":80706298,\"allocated_memory\":28331192,\"available_memory\":49735843,\"parent_ee_ref\":39940718}]},{\"environment\":[]}]}",
"simpletype": "complex"
}
```
### Output Example
```json
{
"environment": [
{
"ee_name": "Lorem in aliquip ea elit",
"eeid": -21467911,
"status": "laboris mollit",
"pause": 1,
"autoboot": 1,
"type": "ea",
"vendor": "pariatur aliqua in dolo",
"version": "dolore",
"allocated_disk_space": 91843673,
"available_disk_space": 80706298,
"allocated_memory": 28331192,
"available_memory": 49735843,
"parent_ee_ref": 39940718
}
]
},
{ "environment": [] }
### Change the current state of the Execution Environment
| Property | Type | Required |
| -------- | ------ | ------------ |
| `input` | object | **Required** |
| `output` | object | Optional |
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| --------- | ------- | ------------ |
| `ee_name` | string | Optional |
| `eeid` | integer | Optional |
| `state` | string | **Required** |
- is optional
- type: `string`
#### state
`state`
- is **required**
##### state Type
`string`
The value of this property **must** be equal to one of the [known values below](#ee_set_state-known-values).
##### state Known Values
| Value |
| ------ |
| start |
| stop |
| pause |
| resume |
ubus call swmodules ee_set_state {"state":"stop","eeid":-51049577,"ee_name":"id officia consectetur nostrud"}
{
"jsonrpc": "2.0",
"id": 0,
"method": "call",
"params": [
"<SID>",
"swmodules",
"ee_set_state",
{ "state": "stop", "eeid": -51049577, "ee_name": "id officia consectetur nostrud" }
```
#### output
`output`
- is optional
- type: `object`
##### output Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------- | ------------ |
| `reason` | string | **Required** |
| `status` | boolean | **Required** |
#### reason
`reason`
- is **required**
- type: `string`
##### reason Type
`string`
### Output Example
```json
{ "status": true, "reason": "dolore adipisicing Ut in" }
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
```
## eu_list
### Get list of execution units (running packages)
`eu_list`
- type: `Method`
### eu_list Type
`object` with following properties:
| Property | Type | Required |
| -------- | ------ | -------- |
| `input` | object | Optional |
| `output` | | Optional |
#### input
`input`
- is optional
- type: `object`
##### input Type
`object` with following properties:
| Property | Type | Required |
| --------- | ------- | -------- |