pteronode
Script for managing Pterodactyl nodes
Pteronode allows you to create sets of allocations on one, many, or all of your IPs and Nodes with a simple command.
HELP
Run python pteronode.py --help for help. You can find us on Discord too at https://discord.gg/q4AeCxgs.
Installing
Right now you need to clone this repo and install the dependencies and run it using Python.
git clone https://github.com/iamkubi/pteronode
cd pteronode
pip install -r requirements.txt
python pteronode.py --help
Sometime soon I'll add a packaged release that can be downloaded and run as a single executable.
Credentials
There are two ways to specify your panel credentials. The easiest option is to specify a config file. By default Pteronode will look for a .pteronode.yml file in the current path. A valid config file looks like this:
> cat .pteronode.yaml
panel: https://panel.test.com
api-key: your-application-api-key-here
Alternatively you can use the --panel and --api_key flags to specify them on the command line.
python pteronode.py --api_key 1234 --panel https://test.com --list_nodes
--list_nodes
This flag allows you to get a quick glance at all of the nodes on your panel. Especially useful for getting Node IDs to for when you want to add allocations.
> python pteronode.py --list_nodes
+----+-------+----------------+----------+--------+------------------+--------+----------------+-------------------+------------------+
| ID | Name | FQDN | Location | Memory | Allocated Memory | Disk | Allocated Disk | Total Allocations | Used Allocations |
+----+-------+----------------+----------+--------+------------------+--------+----------------+-------------------+------------------+
| 1 | test1 | test1.test.com | PDX1 | 62000 | 58000 | 200000 | 163000 | 111 | 23 |
| 2 | test2 | test2.test.com | US-E | 63000 | 0 | 350000 | 0 | 101 | 1 |
+----+-------+----------------+----------+--------+------------------+--------+----------------+-------------------+------------------+
--allocations
Great, so I know my node IDs, now let's make some allocations. By default it will create the same set of allocations on every IP on every node on your panel.
> python pteronode.py --allocations=7777-7800,25565-25665,27015
PteroNode wants to add the following allocations:
+---------+--------------+----------------+---------------------------------------+
| Node ID | IP Address | IP Alias | Allocations |
+---------+--------------+----------------+---------------------------------------+
| 1 | 10.10.10.10 | 123.234.45.678 | ['7777-7800', '25565-25665', '27015'] |
| 2 | 12.34.45.111 | None | ['7777-7800', '25565-25665', '27015'] |
+---------+--------------+----------------+---------------------------------------+
Run again with --no_dry_run to take this action.
By default, this didn't do anything, it just prints out a table showing you what it would create. Run the same command again with --no_dry_run to execute the above.
> python pteronode.py --allocations=7777-7800,25565-25665,27015 --no_dry_run
PteroNode wants to add the following allocations:
+---------+--------------+----------------+---------------------------------------+
| Node ID | IP Address | IP Alias | Allocations |
+---------+--------------+----------------+---------------------------------------+
| 1 | 10.10.10.10 | 123.234.45.678 | ['7777-7800', '25565-25665', '27015'] |
| 2 | 12.34.45.111 | None | ['7777-7800', '25565-25665', '27015'] |
+---------+--------------+----------------+---------------------------------------+
Done! CACAW!
And that's it, it did it! Specifying any allocations that already exist will not cause an error. Those ports will be ignored, and it will create any ports from those ranges that do not exist.
Other flags
There's some more stuff you can do with filters. You can use --nodes to specify a list of node IDs so that it will only add allocations on those nodes.
python pteronode.py --allocations=1234 --nodes=1,2,4
You can filter by IP addresses too.
python pteronode.py --allocations=1234 --ip_addrs=1.1.1.1,8.8.8.8
You can combine them too.
python pteronode.py --allocations=1234 --ip_addrs=1.1.1.1,8.8.8.8 --nodes=1
12 May 7, 2022
61 Dec 17, 2022
7 Mar 25, 2022
14 Jan 17, 2022
2 Oct 26, 2021
1 Oct 25, 2021
2 Oct 29, 2021
5 Mar 25, 2022
2 Jul 6, 2022
0 Jan 23, 2022
1 Jul 5, 2022
1 Oct 23, 2021
92 Jan 25, 2022
249 Dec 23, 2022
385 Dec 31, 2022
401 Dec 11, 2022
4 Sep 2, 2021
4 Sep 9, 2021
27 Dec 20, 2022