Scripts Collection

A collection of useful scripts for various Linux distributions

Scripts

Category / Script	Supports
Asset Tracking / Collect Asset Inventory (SuiteCRM) [Linux]
Asset Tracking / Collect Asset Inventory (SuiteCRM) [Windows]
Backup / Backup Nextcloud Server [Linux]
Disks / Check Disk Health [Linux]
Disks / Check Disk Health [Windows]
Disks / Check Disk Space [Linux]
Disks / Check Disk Space [Windows]
Firewall / Check Firewall Status [Linux]
Firewall / Check Firewall Status [Windows]
Firewall / Firewall - Allow IP/Port [Linux]
Firewall / Firewall - Whitelist IP
Game Server / Install ARK Survival Ascended Dedicated Server
Game Server / Install Palworld
Game Server / Install Project Zomboid
Licensing / Get Windows License Information
Memory / Check Memory Usage [Linux]
Memory / Check Memory Usage [Windows]
Monitoring / Install Graylog Sidecar [Linux]
Monitoring / Install Zabbix Agent2 [Linux]
Monitoring / Install Zabbix Proxy [Linux]
Network Utility / Install net-diag utilities [Linux]
Repo / Switch Repo to Community [Proxmox]
Security / Check Defender Status [Windows]
Security / Install Firewall (UFW) [Linux]
Updates / Check if Reboot Required [Linux]
Updates / Check if Reboot Required [Windows]
User Management / Authorize SSH Key [Linux]
User Management / Get SSH Public Key [Linux]

Compile all scripts

Will compile each script into a single distributable file with all dependencies included within.

python3 compile.py

Script Metadata

Most of the metadata is collected from the file header. To ensure rendering, please ensure all file headers start with # , and separating lines contain a #.

Header scanning will stop as soon as an empty line is encountered.

Example, this will not see the "Supports" section as a header field, and thus will not include it.

#!/bin/bash
#
# Some title

# Supports:
#    Debian 12

Correct form includes a '#' to ensure the entire block is seen as the file header.

#!/bin/bash
#
# Some title
#
# Supports:
#    Debian 12

Script Header

The first non-empty line retrieved from the script will be used as the title, (one line only).

Syntax

Lists how to run the application to the end user, and gets saved in the help icon in TRMM.

#/bin/bash
# ...
# Syntax:
#   --option1 - Short description of option 1
#   --option2=... - Short description of option 2

#!/usr/bin/env python3
"""
...
Syntax:
	--option1 - Short description of option 1
	--option2=... - Short description of option 2
"""

Argument Parsing

Adding # compile:argparse to the script will generate a dynamic argument parser for the script.

(BASH only) Optionally, you can include the destination variable name before each argument to allow for dynamic generation of the argument parsing via compile:argparse.

In this example, passing --noninteractive will set the variable NONINTERACTIVE to 1.

(The compiler will filter out the prefix)

#/bin/bash
# ...
# Syntax:
#   NONINTERACTIVE=--noninteractive - Run in non-interactive mode, (will not ask for prompts)
#   VERSION=--version=... - Version of Zabbix to install DEFAULT=7.0
#   ZABBIX_SERVER=--server=... - Hostname or IP of Zabbix server
#   ZABBIX_AGENT_HOSTNAME=--hostname=... - Hostname of local device for matching with a Zabbix host entry
# ...

# compile:argparse

Generates:

#/bin/bash
# ...
# Syntax:
#   --noninteractive - Run in non-interactive mode, (will not ask for prompts)
#   --version=... - Version of Zabbix to install DEFAULT=7.0
#   --server=... - Hostname or IP of Zabbix server
#   --hostname=... - Hostname of local device for matching with a Zabbix host entry
# ...

# Parse arguments
NONINTERACTIVE="0"
VERSION="7.0"
ZABBIX_SERVER=""
ZABBIX_AGENT_HOSTNAME=""
while [ "$#" -gt 0 ]; do
	case "$1" in
		--noninteractive) NONINTERACTIVE=1; shift 1;;
		--version=*) VERSION="${1#*=}"; shift 1;;
		--server=*) ZABBIX_SERVER="${1#*=}"; shift 1;;
		--hostname=*) ZABBIX_AGENT_HOSTNAME="${1#*=}"; shift 1;;
		-h|--help) usage;;
	esac
done
if [ -z "$SOURCE" ]; then
	usage
fi

#!/usr/bin/env python3
"""
Do something

Syntax:
	--arg1=<str> - Some parameter DEFAULT=yup
	--arg2=<int> - The SSH key to authorize DEFAULT=42
"""

import argparse

# ...

parser = argparse.ArgumentParser(
	prog='scriptname.py',
	description='Does a thing')
# compile:argparse
args = parser.parse_args()

Variable Type

To support Python, ensure a variable type is specified, like so:

#!/usr/bin/env python3
"""
Syntax:
	--option1=<str> - Short description of option 1
	--option2=<int> - Short description of option 2
"""

Argument types in Bash are ignored and are for reference only.

Defaults

The default value can be specified by appending DEFAULT=(value) to the argument, like so:

#/bin/bash
# ...
# Syntax:
#   --option1=<str> - Short description of option 1 DEFAULT=default_value
#   --option2=<int> - Short description of option 2 DEFAULT=42

TRMM Arguments

Lists the default arguments and their values to be used when running the script in TRMM.

DOES support TRMM variable replacement for site, client, and agent. To use these, wrap the variable in double curly braces, like so: {{client.zabbix_hostname}}

#/bin/bash
# ...
# TRMM Arguments:
#   --option1
#   --option2=something

#!/usr/bin/env python3
"""
...
Syntax:
	--option1 - Short description of option 1
	--option2=... - Short description of option 2
"""

TRMM Environment

Behaves the same as TRMM Arguments, but is used for environment variables.

#/bin/bash
# ...
# TRMM Environment:
#   VAR1=something
#   VAR2={{client.zabbix_hostname}}

#!/usr/bin/env python3
"""
...
TRMM Environment:
	VAR1=something
	VAR2={{client.zabbix_hostname}}
"""

Supports

Lists the OS support for the script.

#/bin/bash
# ...
# Supports:
#   Debian 12
#   Ubuntu 24.04

#!/usr/bin/env python3
"""
...
Supports:
	Debian 12
	Ubuntu 24.04
"""

Distros can be listed individually, or one of the group declarations for multiple distros.

• Linux-All - All Linux-based distros (completely os-agnostic script)
• Debian-All - Any Debian-based distro (Debian, Ubuntu, Mint, etc)
• RHEL-All - Any Red Hat-based distro (RHEL, CentOS, Fedora, etc)
• ArchLinux / arch
• CentOS
• Debian
• Fedora
• LinuxMint
• RedHat / RHEL
• Rocky / RockyLinux
• SuSE / OpenSuSE
• Ubuntu
• Windows

Author Tag

#/bin/bash
# ...
# Author:
#   Some Name <[email protected]>

alternative syntax:

#/bin/bash
# ...
# @AUTHOR  Some Name <[email protected]>

#!/usr/bin/env python3
"""
...
@AUTHOR  Some Name <[email protected]>
"""

Category Tag

#/bin/bash
# ...
# Category:
#   Some Category

alternative syntax:

#/bin/bash
# ...
# @CATEGORY  Some Category

#!/usr/bin/env python3
"""
...
Category:
	Some Category
"""

TRMM Timeout Setting

#/bin/bash
# ...
# @TRMM-TIMEOUT  120

#!/usr/bin/env python3
"""
...
@TRMM-TIMEOUT  120
"""

Draft

Set to true to skip finalizing of the script. The script will still be generated to dist/, but will not be recorded in the README and TRMM metafile.

#/bin/bash
# ...
# Draft:
#   True

#!/usr/bin/env python3
"""
...
Draft:
	True
"""

Generative Code

The compiler can generate dynamic code based on script comments, notably for usage and arguments

Compile usage()

Will generate a "usage()" function with the description and syntax arguments.

# compile:usage