Аспро: ЛайтШоп [тема: [ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.]

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 14 Mar 2024 14:30:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Только что попробовал это на своей инфраструктуре. У меня тоже версия 8.1.4, и заработало. Этот скрипт не использует секрет токена API. Вам нужно ввести пароль пользователя в переменную apip. Будет первый вызов API для получения тикета и куки, которые затем будут использоваться для входа и генерации действия. apiu — это user@realm, а apip — пароль этого пользователя. (Тот же пароль, что и для GUI). Если ваш пользователь основан на LDAP-каталоге, например, ваш логин должен выглядеть как user@domain.loc.
14.03.2024 14:30:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 14 Mar 2024 06:57:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Это же токен для однократного использования. Но в твоем скрипте, похоже, ты что-то закрасил и заменил, я не знаю. В принципе, тебе нужен API-пользователь с его токеном при создании. Я этот скрипт не использую, так что не пытай меня!
14.03.2024 06:57:00, gfngfn256.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 13 Mar 2024 23:24:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Так, я в 8.1.4. Скопировал твой скрипт на rpi и поправил переменные. Создал пользователя, добавил токен API. У нового пользователя права администратора. Когда запускаю скрипт и смотрю syslog, вижу "authentication failure; rhost=::ffff:10.20.20.166 user=AGVuser@pve msg=invalid credentials". Это пароль – это реальный пароль пользователя или это одноразовый токен, который выдается при создании токена? Просто хочу, чтобы скрипт запускал VM при запуске.

Код:
#!/bin/bash
##################################
### API AUTOMATION
# для сообщества proxmox
# By veeh, enjoy

#Информация о хосте
pve="10.20.20.20"
node="pvetemp"
port=":8006"
vmid="301"

#Информация об API
apiu="VMuser@pve"
apip="USERSloginPASSWORD"
url_base="https://$pve$port/api2/json"
# сюда вставляешь что хочешь делать
# https://pve.proxmox.com/pve-docs/api-viewer/
url_end="nodes/$node/qemu/$vmid/status/start"
urlqr="$url_base/$url_end"
urltk="$url_base/access/ticket"

ticket=`curl --insecure --data "username=$apiu&password=$apip" $urltk`

# Извлекаем cookie и токен из данных ticket
cookieid=`echo $ticket | tr -t '"' '\n' | grep "PVE:$apiu"`
cookie="PVEAuthCookie=$cookieid"
ticketid=`echo $cookie | awk -F ':' '{ print $3 }'`
tokenid=`echo $ticket | tr -t '"' '\n' | grep $ticketid | grep -v PVE`
token="CSRFPreventionToken:$tokenid"

#запрос API proxmox
curl --insecure --cookie $cookie --header $token -X POST "$urlqr"
13.03.2024 23:24:00, CPBPILOT.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 21 Dec 2023 10:53:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Токены API не требуют двухфакторную аутентификацию (TFA). Их задача — предоставить ограниченный доступ к API, который можно использовать в скриптах и других приложениях без необходимости многократно запрашивать билет. TFA в скриптах не имеет особого смысла, ведь это будет еще один секрет, лежащий рядом с токеном. Поскольку токен API выступает как обходной путь TFA, настоятельно рекомендуется реально ограничивать его область доступа только тем, что нужно скрипту.
21.12.2023 10:53:00, Folke.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 21 Dec 2023 10:31:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Я разобрался в другой ветке с помощью Folke (сотрудника Proxmox): # обратите внимание на -r в команде jq, чтобы результат не заключался в кавычки и не экранировался
curl -f -s -S -k --data-urlencode "username=root@pam" --data-urlencode "password=$PASSWORD" "https://cl1:8006/api2/json/access/ticket"|jq -r '.data.ticket' > cookie

curl --silent --insecure --data-urlencode "username=root@pam" --data-urlencode "password=totp:$(oathtool -b --totp "$TOTP_SECRET")" --data-urlencode "tfa-challenge=$(https://cl1:8006/api2/json/access/ticket. С этими двумя строками я сумел получить валидный билет, пройдя двухфакторную аутентификацию... Надеюсь, это поможет и другим людям......
21.12.2023 10:31:00, Domenico.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 20 Dec 2023 23:57:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Без понятия, извини, Доменико. Я ничего не настраивал с TFA, так что не знаю. Может, кто-то другой сможет тебе помочь. Или если ты используешь отдельные права для API-токена, возможно, получится обойти TFA. Я просто так думаю.
20.12.2023 23:57:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 20 Dec 2023 08:46:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет, а если у apiuser включена двухфакторная аутентификация? Как мне изменить curl?
20.12.2023 08:46:00, Domenico.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 15 Dec 2022 15:48:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Я не очень хорошо знаю API, но если проверить просмотрщик API https://pve.proxmox.com/pve-docs/api-viewer/, нужно указать имя ноды. Не думаю, что можно использовать подстановочный знак. Возможно, есть способ получить список ВМ для каждой ноды через API. Но это всего лишь догадка. А затем из списка можно запустить цикл, чтобы проверить, есть ли там искомый vmid, или переходить к следующей ноде. Поскольку всё это можно сделать через SSH. Что-то вроде этого:

Код:
#!/bin/bash
VMID=$1
hypvsr="node1 node2 node3 node4"

for i in $hypvsr; do
j=$(ssh $i "sudo qm list | grep $VMID")

if [ ! -z "$j" ]; then
node=$i
break
fi
done

Остальная часть скрипта. Но тебе нужен пользователь с sudo и без запроса пароля. И, что самое главное, это сводит на нет смысл использования API, потому что оттуда можно запустить что угодно.
15.12.2022 15:48:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 15 Dec 2022 07:50:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет! Да, получилось, спасибо большое! Подскажи, возможно ли сделать так, чтобы можно было перезапускать и прочее, не привязываясь к конкретному узлу? У меня огромное количество серверов, и машина часто переезжает, из-за чего приходится вручную редактировать твой скрипт каждый раз, когда машина с vmid 100 переезжает с node1 на node2/3/4… в общем, спасибо за потраченное время!
15.12.2022 07:50:00, Kosh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 14 Dec 2022 20:32:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Ты оказался прав!! Там была ошибка в bash-скрипте. В переменной cookieid. Я забыл заменить поле user на $apiu. Там было api@pve. Ну, конечно, у меня всё работало, потому что это пользователь, под которым я зашёл... Я исправил. Попробуй ещё раз.
14.12.2022 20:32:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 14 Dec 2022 20:09:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Работает у меня отлично. Посмотри в свой syslog. Там должны быть записи о попытках использования API. В моем случае пользователь — 'api@pve'. 14 дек 13:00:13 qxmx pvedaemon[2121831]: успешная авторизация для пользователя 'api@pve'. 14 дек 13:00:13 qxmx pvedaemon[2121831]: начинаю задачу UPID:qxmx:0011B691:05F3A38C:639A1D3D:qmstart:107:api@pve. Если ты видишь успешную авторизацию, но не видишь действия, я бы посоветовал проверить права пользователя API. Или, возможно, есть опечатка в вызове API. Помню, у меня были проблемы с правами пользователя API, когда я настраивал это. По умолчанию роль, которую ты присваиваешь пользователю, будет той, которая нужна для API. Но можно также иметь отдельные права.
14.12.2022 20:09:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 14 Mar 2024 18:58:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Я наконец-то смог заставить это работать. Немного подправил под формат, указанный в этом руководстве по созданию тонкого клиента. Также добавил это в .bash_profile на pi, чтобы при запуске pi скрипт проверял, работает ли vm, если нет – запускал или возобновлял vm, а затем подключался к виртуальному рабочему столу. Получается неплохой тонкий клиент, и это позволяет освободить ресурсы на сервере, если он не используется, и перезапускать vm прямо с pi. В .bash_profile выглядит так:
```bash
[[ -z $DISPLAY && $XDG_VTNR -eq 1 ]] && (sh /home/pi/vmstart.sh && startx --)
```
Я сохранил этот скрипт как vmstart.sh в домашней директории, и он выглядит так:
```bash
#!/bin/bash
echo "$PROXY is reachable!"
# Set auth options
PASSWORD='Users_login_password'
USERNAME='VMuser@pve'
# Set VM ID
VMID="VMID"
# Set Node
# This must either be a DNS address or name of the node in the cluster
NODE="HOSTID"
# Proxy equals node if node is a DNS address
# Otherwise, you need to set the IP address of the node here
PROXY="HOST_FQDN_OR_IP"
NODE="${NODE%%\.*}"
# Function to check if the IP is reachable
check_ip() {
ping -c 1 $1 > /dev/null 2>&1
}
echo "Waiting for $PROXY to become reachable..."
# Loop until the IP is reachable
while ! check_ip $PROXY; do
sleep 1
done
# gets auth thicket form the proxmox server
ticket="$(curl -f -s -S -k --data-urlencode "username=$USERNAME" --data-urlencode "password=$PASSWORD" "https://$PROXY:8006/api2/json/access/ticket")"
echo "AUTH OK"
# Grab cookie and token from the ticket data
cookieid=`echo $ticket | tr -t '"' '\n' | grep "PVE:$USERNAME"`
cookie="PVEAuthCookie=$cookieid"
ticketid=`echo $cookie | awk -F ':' '{ print $3 }'`
tokenid=`echo $ticket | tr -t '"' '\n' | grep $ticketid | grep -v PVE`
token="CSRFPreventionToken:$tokenid"
#proxmox api query
status='Unknown'
while [ $status != "qmpstatus:running" ]; do
statusreturn=$(curl --insecure --cookie $cookie --header $token -X GET https://$PROXY:8006/api2/json/nodes/$NODE/qemu/$VMID/status/current)
#echo $statusreturn
status=`echo $statusreturn | tr -t ',' '\n' | grep 'qmpstatus'`
#echo $status
status=`echo $status | tr -d '"' `
echo $status
if [ $status = "qmpstatus:running" ]; then
echo "VM running"
elif [ $status = "qmpstatus:stopped" ]; then
echo "Starting VM"
curl --insecure --cookie $cookie --header $token -X POST https://$PROXY:8006/api2/json/nodes/$NODE/qemu/$VMID/status/start
elif [ $status = "qmpstatus:suspended" ]; then
echo " Restarting VM"
curl --insecure --cookie $cookie --header $token -X POST https://$PROXY:8006/api2/json/nodes/$NODE/qemu/$VMID/status/stop
sleep 5
curl --insecure --cookie $cookie --header $token -X POST https://$PROXY:8006/api2/json/nodes/$NODE/qemu/$VMID/status/start
elif [ $status = "qmpstatus:paused" ]; then
echo " Resuming VM"
curl --insecure --cookie $cookie --header $token -X POST https://$PROXY:8006/api2/json/nodes/$NODE/qemu/$VMID/status/resume
else
echo "Unknown status:" $status
fi
done
```
Один момент: мне не пришлось создавать API-токен. Нужно было только создать пользователя и предоставить ему разрешения PVEVMuser.
14.03.2024 18:58:00, CPBPILOT.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 14 Dec 2022 10:13:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Спасибо за уточнение. К сожалению, пока что включить VM через ваш скрипт невозможно, поэтому VM запускается командой pvesh create /nodes/cloud-p013/qemu/137/status/start PVE 7.2
14.12.2022 10:13:00, Kosh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Tue, 13 Dec 2022 17:36:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Нет, если посмотреть на скрипт ниже, $url_base = "https://$pve$port/api2/json" [...] $url_end = "/nodes/$node/qemu/$vmid/status/start". $node используется в API-вызове, поэтому это просто имя твоего гипервизора. $pve используется в URL, и тебе нужен FQDN или IP гипервизора. Может быть, что-то вроде этого: node=NODENAME pve=$node.yourdomain.loc Но убедись, что node определён перед pve в этом случае.
13.12.2022 17:36:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Tue, 13 Dec 2022 15:43:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Я думал, это стоит здесь перечислить? - pve=" HOST_FQDN_OR_IP "
13.12.2022 15:43:00, Kosh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Tue, 13 Dec 2022 15:34:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет! Это имя гипервизора Proxmox. На скриншоте, приложенном к сообщению, это будет pxmx или qxmx.
13.12.2022 15:34:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Tue, 13 Dec 2022 15:13:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет node="HOSTID", что здесь нужно указать?
13.12.2022 15:13:00, Kosh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Thu, 10 Feb 2022 00:47:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет! Этот скрипт использует API систему, доступную в Proxmox 6.7, если я правильно помню (в версии 7 точно есть). Вам нужно предоставить информацию о хосте и учетные данные API. pve="HOST_FQDN_OR_IP" node="HOSTID" port=":8006" vmid="VMID" apiu="user@realm" apip="USER_PASSWORD".

Сначала нужно создать учетную запись для использования API системы. Datacenter > Permissions > API Tokens, затем добавьте своего пользователя. Это ваши учетные данные API. https://pve.proxmox.com/wiki/Proxmox_VE_API

Скрипт создает тикет для выполнения действия. Действие определяется переменной $url_end url_end="nodes/$node/qemu/$vmid/status/stop" (в данном случае это действие остановит ВМ $vmid).

Если у вашего API пользователя есть необходимые разрешения, вы можете выполнять всё, что угодно, если это указано здесь: https://pve.proxmox.com/pve-docs/api-viewer/index.html

Еще один пример: nodes/{node}/status/reboot (это перезагрузит ваш хост).

Базовый URL для вашего API всегда одинаковый: https://HOSTIP:8006/api2/json. Важно то, что идет после него — это говорит системе, что нужно делать.

Последняя часть запроса в тикете содержит информацию, необходимую для запуска API-действия.

В итоге, вот как это работает: ваш API пользователь позволяет получить тикет, в котором содержится вся необходимая информация для запуска запрошенного API-действия, при условии, что у пользователя есть нужные разрешения.

Вы можете запускать это с любого устройства. Я использую это на своем ноутбуке, чтобы включать/перезагружать/выключать ВМ на своей рабочей станции. Но вы также можете запустить это со своего телефона. С приложением, отправляющим HTTP POST-запросы. Это немного сложнее, потому что нужен токен. Но это работает отлично.
10.02.2022 00:47:00, Veeh.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Wed, 09 Feb 2022 19:10:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет, я не эксперт, так что, пожалуйста, можешь немного подробнее объяснить мне про этот скрипт? Bash-код должен запускаться с устройства, которое будет отправлять команду пробуждения на VM? Какие данные мне нужно изменить в твоём bash? Спасибо.
09.02.2022 19:10:00, Norbertt.

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее.

Mon, 12 Jul 2021 22:54:00 +0300

[ТУТОРИАЛ] Автоматизация API, включение/выключение VM и прочее. Proxmox Виртуальная Среда в форуме Proxmox Виртуальная Среда.
Привет, сообщество Proxmox! Я последние несколько дней работал над этим, и, думаю, это может пригодиться некоторым из вас, поэтому решил поделиться. У меня дома есть ВМ, которые не работают постоянно. Раньше я использовал WOL + python-скрипт для включения ВМ. После обновления до proxmox7 это больше не работало, и вместо установки python2 библиотеки я решил использовать API. Вот что получилось. Предлагаю два следующих скрипта (PowerShell и Bash), которые отправляют запрос для получения тикета, а затем используют данные из этого тикета, чтобы выполнять любые действия, которые вы укажете в конечной точке! Приятно использовать.

PowerShell:

```
# API AUTOMATION
# for the proxmox community
# By veeh, enjoy
#
# Требование: не работает с Powershell5.1, я делал это с powershell7.

# Информация о хосте
$pve = "HOST_FQDN_OR_IP"
$node = "HOSTID"
$port = ":8006"
$vmid = "VMID"

# Информация об API
$apiu = "user@realm"
$apip = "USER_PASSWORD"
$url_base = "https://$pve$port/api2/json"
# Здесь нужно указать, что именно вы хотите сделать
# https://pve.proxmox.com/pve-docs/api-viewer/
$url_end = "/nodes/$node/qemu/$vmid/status/start"
$urlqr = $url_base + $url_end
$urltk = "$url_base/access/ticket"

# Создание тикета
$ticket = curl --insecure --data "username=$apiu&password=$apip" $urltk

# Разбор данных тикета для извлечения cookie и токена
$Array = $ticket.Split('"')
# Извлечение cookie
$linecookie = $Array | select-string ticket
$linecookienb = $linecookie.LineNumber + 1
$cookie = $Array | select -Index $linecookienb
# Извлечение токена
$linetoken = $Array | select-string CSRFP
$linetokennb = $linetoken.LineNumber + 1
$token = $Array | select -Index $linetokennb

# Запрос к API Proxmox
$headersps = @{
"cookie" = "PVEAuthCookie=$cookie"
"CSRFPreventionToken" = "$token"
}
Invoke-RestMethod -SkipCertificateCheck -Uri $urlqr -Method Post -Headers $headersps
```

Bash:

```
#!/bin/bash
##################################
### API AUTOMATION
# for the proxmox community
# By veeh, enjoy

# Информация о хосте
pve="HOST_FQDN_OR_IP"
node="HOSTID"
port=":8006"
vmid="VMID"

# Информация об API
apiu="user@realm"
apip="USER_PASSWORD"
url_base="https://$pve$port/api2/json"
# Здесь нужно указать, что именно вы хотите сделать
# https://pve.proxmox.com/pve-docs/api-viewer/
url_end="nodes/$node/qemu/$vmid/status/start"
urlqr="$url_base/$url_end"
urltk="$url_base/access/ticket"

ticket=`curl --insecure --data "username=$apiu&password=$apip" $urltk`

# Извлечение cookie и токена из данных тикета
cookieid=`echo $ticket | tr -t '"' '\n' | grep "PVE:$apiu"`
cookie="PVEAuthCookie=$cookieid"
ticketid=`echo $cookie | awk -F ':' '{ print $3 }'`
tokenid=`echo $ticket | tr -t '"' '\n' | grep $ticketid | grep -v PVE`
token="CSRFPreventionToken:$tokenid"

# Запрос к API Proxmox
curl --insecure --cookie $cookie --header $token -X POST "$urlqr"
```
12.07.2021 22:54:00, Veeh.