Skip to content
Snippets Groups Projects
swmodules.md 21.8 KiB
Newer Older
  • Learn to ignore specific revisions
  • | `ee_name` | string  | Optional |
    | `eeid`    | integer | Optional |
    
    #### ee_name
    
    `ee_name`
    
    - type: `string`
    
    ##### ee_name Type
    
    #### eeid
    
    - type: `integer`
    
    ##### eeid Type
    
    `integer`
    
    ubus call swmodules eu_list {"eeid":2,"ee_name":"eiusmod"}
    
    Vivek Dutta's avatar
    Vivek Dutta committed
    
    ```json
    {
    
      "jsonrpc": "2.0",
      "id": 0,
      "method": "call",
    
      "params": ["<SID>", "swmodules", "eu_list", { "eeid": 2, "ee_name": "eiusmod" }]
    
    }
    ```
    
    #### output
    
    `output`
    
    - is optional
    - type: complex
    
    ##### output Type
    
    Unknown type ``.
    
    ```json
    {
      "oneof": [
    
    Vivek Dutta's avatar
    Vivek Dutta committed
        {
          "type": "object",
          "properties": {
    
            "execution_unit": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
    
                    "eu_name": {
    
                      "type": "string"
                    },
                    "command": {
                      "type": "string"
                    },
                    "state": {
                      "type": "string"
                    },
                    "config": {
                      "type": "string"
                    },
                    "version": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
    
                    "ee_name": {
    
                    "eeid": {
    
                      "type": "integer",
                      "minimum": 1
                    },
                    "euid": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "disk_space": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "memory_space": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "vendor": {
                      "type": "string"
                    }
                  },
                  "required": [
    
                    "eu_name",
    
                    "config",
                    "version",
                    "description",
    
                    "ee_name",
                    "eeid",
    
                    "euid",
                    "disk_space",
                    "memory_space",
                    "vendor"
                  ]
                }
              ]
    
    Vivek Dutta's avatar
    Vivek Dutta committed
            }
    
          }
        },
        {
          "type": "object",
          "properties": {
            "execution_unit": {
              "type": "array",
              "items": []
            }
          }
    
    Vivek Dutta's avatar
    Vivek Dutta committed
        }
      ],
    
      "out": "{\"oneof\":[{\"execution_unit\":[{\"eu_name\":\"in est aliqua aliquip\",\"command\":\"proident et \",\"config\":\"reprehenderit nisi qui esse\",\"version\":\"deserunt quis do qui laborum\",\"description\":\"ipsum fugiat non\",\"ee_name\":\"enim\",\"euid\":18216158,\"disk_space\":13070620,\"memory_space\":67344135,\"vendor\":\"consequat\",\"state\":\"enim sed dolore est elit\",\"eeid\":7}]},{\"execution_unit\":[]}]}",
    
      "simpletype": "complex"
    
    Vivek Dutta's avatar
    Vivek Dutta committed
    }
    ```
    
    ### Output Example
    
    ```json
    {
    
    Vivek Dutta's avatar
    Vivek Dutta committed
        {
    
              "eu_name": "in est aliqua aliquip",
    
              "command": "proident et ",
              "config": "reprehenderit nisi qui esse",
              "version": "deserunt quis do qui laborum",
              "description": "ipsum fugiat non",
    
              "ee_name": "enim",
    
              "euid": 18216158,
              "disk_space": 13070620,
              "memory_space": 67344135,
              "vendor": "consequat",
              "state": "enim sed dolore est elit",
    
              "eeid": 7
    
    
    ## eu_set_state
    
    ### Start or stop the execution of an EU
    
    `eu_set_state`
    
    - type: `Method`
    
    ### eu_set_state 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     |
    | `eu_name` | string  | **Required** |
    | `state`   | boolean | **Required** |
    
    #### ee_name
    
    `ee_name`
    
    - is optional
    - type: `string`
    
    ##### ee_name Type
    
    `string`
    
    #### eeid
    
    `eeid`
    
    - is optional
    - type: `integer`
    
    ##### eeid Type
    
    `integer`
    
    #### eu_name
    
    `eu_name`
    
    - is **required**
    - type: `string`
    
    ##### eu_name Type
    
    `string`
    
    #### state
    
    `state`
    
    - is **required**
    - type: `boolean`
    
    ##### state Type
    
    `boolean`
    
    ### Ubus CLI Example
    
    ```
    ubus call swmodules eu_set_state {"eu_name":"in do ea sed Excepteur","state":true,"eeid":93105262,"ee_name":"ipsum pariatur"}
    ```
    
    ### JSONRPC Example
    
    ```json
    {
      "jsonrpc": "2.0",
      "id": 0,
      "method": "call",
      "params": [
        "<SID>",
        "swmodules",
        "eu_set_state",
        { "eu_name": "in do ea sed Excepteur", "state": true, "eeid": 93105262, "ee_name": "ipsum pariatur" }
      ]
    }
    ```
    
    #### 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": false }
    ```