Merge pull request #910 from silversword411/develop

docs - script temp, support, updating script run info, mesh agent blank data
This commit is contained in:
Dan
2022-01-03 13:28:31 -08:00
committed by GitHub
5 changed files with 29 additions and 8 deletions

View File

@@ -7,6 +7,7 @@ Tactical RMM supports uploading existing scripts or adding new scripts right in
- Python
## Adding Scripts
In the dashboard, browse to **Settings > Scripts Manager**. Click the **New** button and select either Upload Script or New Script. The available options for scripts are:
- **Name** - This identifies the script in the dashboard
@@ -16,7 +17,7 @@ In the dashboard, browse to **Settings > Scripts Manager**. Click the **New** bu
- Powershell
- Windows Batch
- Python
- **Script Arguments** - Optional way to set default arguments for scripts. These will autopopulate when running scripts and can be changed at runtime.
- **Script Arguments** - Optional way to set default arguments for scripts. These will auto populate when running scripts and can be changed at runtime.
- **Default Timeout** - Sets the default timeout of the script and will stop script execution if the duration surpasses the configured timeout. Can be changed at script runtime
- **Favorite** - Favorites the script.
@@ -26,7 +27,7 @@ To download a Tactical RMM Script, click on the script in the Script Manager to
## Community Scripts
These are script that are built into Tactical RMM. They are provided and mantained by the Tactical RMM community. These scripts are updated whenever Tactical RMM is updated and can't be modified or deleted in the dashboard.
These are script that are built into Tactical RMM. They are provided and maintained by the Tactical RMM community. These scripts are updated whenever Tactical RMM is updated and can't be modified or deleted in the dashboard.
### Hiding Community Scripts
You can choose to hide community script throughout the dashboard by opening **Script Manager** and clicking the **Show/Hide Community Scripts** toggle button.
@@ -43,7 +44,9 @@ In the **Agent Table**, you can right-click on an agent and select **Run Script*
- **Save as Note** - Saves the output as a Note that can be views in the agent Notes tab
- **Collector** - Saves to output to the specified custom field.
There is also an option on the agent context menu called **Run Favorited Script**. This will essentially Fire and Forget the script with default args and timeout.
There is also an option on the agent context menu called **Run Favorited Script**. This will pre-populate the script run dialog with the script of your choice.
[Script Execution Process](../../howitallworks/#windows-agent)
### Script Arguments
@@ -62,7 +65,7 @@ and `()` indicates a default parameter if none is specified
### Bulk Run on agents
There is also an option on the agent context menu called **Run Favorited Script**.
Under the tools menu -> Run Bulk Script you can execute scripts against Clients/Sites/Selected Agents/All based on All/Servers/Workstations
### Automated Tasks
@@ -93,7 +96,7 @@ Tactical RMM allows passing in dashboard data to scripts as arguments. The below
!!!info
Everything between {{}} is CaSe sEnSiTive
See a full list of available options [Here](../script_variables.md)
See a full list of possible built-in variables [Here](../script_variables.md)
### Getting Custom Field values

View File

@@ -216,7 +216,7 @@ Built on the Django framework, the Tactical RMM service is the heart of system b
#### NATS API service
The NATS API service is a very light golang wrapper to replace traditional http requests sent to django. The agent sends the data to nats-api which is just always listening for agent requests (on Port 4222). It then saves the data to postgres directly.
The NATS API service is a very light golang wrapper to replace traditional http requests sent to django. The agent sends the data to nats-api which is always listening for agent requests (on Port 4222). It then saves the data to postgres directly.
???+ note "systemd config"
@@ -379,6 +379,14 @@ zipp==3.4.1
Found in `%programfiles%\TacticalAgent`
When scripts/checks execute, they are:
1. transferred from the server via nats
2. saved to a randomly created file in `c:\windows\temp\trmm\`
3. executed
4. Return info is captured and returned to the server via nats
5. File in `c:\windows\temp\trmm\` are removed automatically after execution/timeout.
### Outbound Firewall Rules
If you have strict firewall rules these are the only outbound rules from the agent needed for all functionality:

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -8,7 +8,7 @@ Note: If you don't want to share any specific info publicly on discord you can D
Server Install Specific questions:
4. What version of Ubuntu/Debian, is it a Desktop or Server
5. Are you using a real domain
6. Did letsencrypt finalise and work
6. Did letsencrypt finalize and work
7. Have you looked at the troubleshooting steps on github? https://wh1te909.github.io/tacticalrmm/troubleshooting/
8. What kind of ssl certs? Let's Encrypt, or purchased (you're not trying to make self-signed work right?)
9. Check Expiry date of your certificates in the browser (at https://rmm.example.com )
@@ -17,3 +17,7 @@ Network Troubleshooting
10. Are you using a proxy?
11. Are you a wizard? See https://wh1te909.github.io/tacticalrmm/unsupported_guidelines/
If so, what's in the network between agent and server?
Agent Troubleshooting
12. Is there ANY 3rd party Antivirus installed on the computer?
13. Is there any network based filtering/AV filtering?

View File

@@ -204,4 +204,10 @@ Login to server with SSH and run:
```bash
node /meshcentral/node_modules/meshcentral --logintokenkey
```
```
## Mesh Agent Not Connecting to server
When agents don't show up in your mesh console (after logging into https://mesh.EXAMPLE.COM), and all data is blank. Your AV has most likely blocked the agent.
![Mesh Not Connecting](images/mesh_no_data.png)