Actions

Actions are single RPC calls made to a plugin command. They pass on some parameters that may match, for example a service.

There are two kind of actions, command based, which are automatisable, and screen actions, that open new screens with some UI.

Manifest YAML component definition

Command based

components:
  - name: Ping server
    id: ping
    type: action
    command: serverboards.core.actions/cmd
    call:
      method: ping
      params:
        - name: ip
          label: Remote IP address or DNS name
          type: text
      result:
        ms: ms that took to do the ping
    traits: ip url # this means any of `ip` or `url`
Field Description
command Command id to execute, as plugin id/component id. See commands
call Method on the command to call, with the given parameters, specified as Generic Forms Fields
traits This action is callable by any service with any of the given traits
return Object with the name of the attributes it returns and the description

Screen based

[MAY BE MOVED TO A NEW COMPONENT TYPE]

components:
  - name: Pinger console
    type: action
    traits: ip url
    id: pinger
    screen:
      html: index.html
      js: index.js
Field Description
screen Screen definition as defined in Screen Definitions