query if a backup task is running

[RockNLol]

hi,
in my homelab I'm running PBS as a VM on my workstation. Before each scheduled backup I wake it up via WoL. Now I'm looking for a way to shut it down, when the backup is complete.
Can I somehow query, if a backup task is currently running? I then could just cron check, and if no backup task is active shut down the workstation again.

thanks in advance!

 

[Dunuin]

Need to do something similar soon but a bit more dvanced with also checking if a GC, Verify or Prune job is running.

Would be great if someone could give an example how to check that using the API. And how to shutdown the PBS using API too.

 

[RockNLol]

/api2/json/nodes/{node}/tasks?running=true lists currently running tasks and has a total count in the returned json, which can be checked if zero. This also lists GC, Verify and Prune jobs.
Heres the link to the documentation: PBS Documentation

*edit: Yeah, no idea on how to query this repeatedly by a script. I don't get the authentication to work outside of logged in browser.

 

[uihuizui]

Does the API deliver tasks for PVE & PBS when they are on same server or do I need to query both by using different ports?

 

[Chris]

*edit: Yeah, no idea on how to query this repeatedly by a script. I don't get the authentication to work outside of logged in browser.

Hi,
an API Token should be used for authorization from scripts.

A basic curl example: curl -H 'Authorization: PBSAPIToken=<username>@pam!<tokenname>:<token-secret-value>' "https://<domainname-or-ip>:8007/api2/json/nodes/localhost/tasks?running=true. For self signed certificates, curls -k option is required to accept the certificate and continue with the connection.

 

[Chris]

Does the API deliver tasks for PVE & PBS when they are on same server or do I need to query both by using different ports?

Those are two completely separated api servers, so you will have to query them individually. PVE listens on port 8006, PBS on port 8007

Edit: Of course also with different credentials/api tokens

 

[Digdug]

Bash to check (using python and JSON so you can get other values as well)

result=$(curl -s -k -H 'Authorization: PBSAPIToken=<username>@pam!<tokenname>:<token-secret-value>' "https://<domainname-or-ip>:8007/api2/json/nodes/localhost/tasks?running=true")
tasks=$(echo $result | python3 -c "import sys, json; print(json.load(sys.stdin)['total'])")

 

[Petr Swetr]

trying in my local network:

curl -s -k -H 'Authorization: PBSAPIToken=root@pam!testN:<token-secret-value>' "https://192.168.0.201:8007/api2/json/nodes/localhost/tasks?running=true"

Always returning

{"total":0,"data":[]}

 

[Petr Swetr]

Hi,
an API Token should be used for authorization from scripts.

A basic curl example: curl -H 'Authorization: PBSAPIToken=<username>@pam!<tokenname>:<token-secret-value>' "https://<domainname-or-ip>:8007/api2/json/nodes/localhost/tasks?running=true. For self signed certificates, curls -k option is required to accept the certificate and continue with the connection.

here the returned number increments when the new backup task finishes

 ....https://192.168.0.201:8007/api2/json/nodes/localhost/tasks\?running=false\&limit=10000 | jq .total

following returns always 0 (even when backup task is started manually from the Proxmox server and from the web interface it is obvious task is still running)

 ....https://192.168.0.201:8007/api2/json/nodes/localhost/tasks\?running=true\&limit=10000 | jq .total

 

[Digdug]

here the returned number increments when the new backup task finishes

 ....https://192.168.0.201:8007/api2/json/nodes/localhost/tasks\?running=false\&limit=10000 | jq .total

following returns always 0 (even when backup task is started manually from the Proxmox server and from the web interface it is obvious task is still running)

 ....https://192.168.0.201:8007/api2/json/nodes/localhost/tasks\?running=true\&limit=10000 | jq .total

Set the permissions to /

 

[Petr Swetr]

Set the permissions to /

Do you mean this?
Go to Datacenter -> Permissions, there add a new User permission with the path "/" for your user and the appropriate role. Make sure the "Propagate" Checkbox is enabled so that the permission propagates down to all the child elements of the permissions paths.

 

[Petr Swetr]

Set the permissions to /

On the PBS I created API token for the user root@pam. Than in Permissions I added API token permission with the path / for that API token.
Now the query with running=false works. Thanks

 

[Digdug]

View attachment 51478View attachment 51477

Yes, you can even set it to

/system/tasks

And I assume you added the API tokenas well to the curl command.

 

[Petr Swetr]

Yes, you can even set it to

/system/tasks

And I assume you added the API tokenas well to the curl command.

Yes, I use the token.
New problem arise, there are short breaks between backups (multiple Proxmox VMs are backed up) .
I would like to shut the backup server down when the running=false query returns 0 (my backups are once a day starting 23:55 and the time of execution of all backups is in the interval 2minutes - 5 hours).
How to discover if/how many backup tasks are in the schedule waiting to be executed in the future?