Shortcuts
Shortcuts are used to run Commands and Flight Plans on Servers in one click.
Access Rules
| Group | Action | Condition |
|---|---|---|
| User | R | Access level is "User" and user is added in "Users" in related Servers |
| Manager | R | Access level is "Manager" or less and user is added in "Users" or "Managers" in related Servers |
| Root | CRUD | Any record |
Info
CRUD stands for Create, Read, Update, Delete
Shortcut access level overrides access level of the Command or Flight Plan it is triggering. This allows to run Commands or Flight Plans with higher access level than current user's access level.
Shortcut Configuration
Shortcuts are located under the Cetmix Tower > Settings > Shortcuts menu.
Fields
| Field | Description |
|---|---|
| Name | Command readable name. |
| Reference | Used for Odoo automation and YAML export/import. Leave blank to generate it automatically. |
| Access Level | Minimum access level required to run this Command. |
| Active | If disabled, the Shortcut will not be available in the server form. |
| Sequence | Specifies the order of the Shortcut in the server form. Lower value means higher position. |
| Action | Action triggered by the Shortcut. Possible options: Command and Flight Plan |
| Command | Command to be executed by the Shortcut. This field is available if Action is "Command". |
| Flight Plan | Flight Plan to be executed by the Shortcut. This field is available if Action is "Flight Plan". |
| Note | Shortcut description. |
Notebook Tabs
| Tab | Description |
|---|---|
| Servers | List of Servers where the Shortcut is available. |
| Servers Templates | List of Servers Templates where the Shortcut is available. |
| YAML | YAML code of the Shortcut. This tab is visible only to users with "Cetmix Tower YAML > Export" setting enabled. |
Hint
Click a shortcut in the server form to see the Shortcut's note. Use this feature to provide additional information about what the Shortcut does.
YAML Format Specification
cetmix_tower_model: shortcut
reference: flight_plan_shortcut_for_server_template
name: Flight Plan Shortcut for Server Template
sequence: 10 # Integer. Position of the shortcut in the server form. Lower value means higher position.
access_level: user # Possible values: user, manager, root
action: plan # Possible values: command, plan
command_id: demo_command_1 # Command reference or a Command object. Used only for the 'command' action
use_sudo: false # Boolean. Run command using 'sudo'. Used only for the 'command' action
plan_id: demo_plan_1 # Flight Plan reference or Flight Plan object. Used only for the 'plan' action
note: Runs a flight plan. # Text. Shortcut description.
Please refer to the General YAML Format Specification for more details.