proxmox - управление экземплярами в кластере Proxmox VE
Новая версия 2.0.
Обзор
- позволяет создавать/удалять/останавливать экземпляры в кластере Proxmox VE
- Начиная с Ansible 2.1, автоматически обнаруживает тип контейнеризации (lxc для PVE 4, openvz для более старых версий)
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- proxmoxer
- python >= 2.7
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_host обязательно | хост кластера Proxmox VE | |
| api_password | По умолчанию: None | пароль для аутентификации можно использовать переменную окружения PROXMOX_PASSWORD |
| api_user обязательно | пользователь для аутентификации | |
| cores (добавлен в 2.4) | По умолчанию: 1 | Укажите количество ядер на сокет. |
| cpus | По умолчанию: 1 | количество выделенных ЦП для экземпляра |
| cpuunits | По умолчанию: 1000 | Вес ЦП для виртуальной машины |
| disk | По умолчанию: 3 | размер жесткого диска в ГБ для экземпляра |
| force |
| принудительное выполнение операций может использоваться только с состояниями present, stopped, restartedс параметром force можно перезаписать существующий контейнер с состояниями stopped, restarted можно принудительно остановить экземпляр |
| hostname | По умолчанию: None | имя хоста экземпляра требуется только для state=presentдолжно быть уникальным, если не указан vmid |
| ip_address | По умолчанию: None | устанавливает адрес, который будет присвоен контейнеру |
| memory | По умолчанию: 512 | размер памяти в МБ для экземпляра |
| mounts (добавлен в 2.2) | По умолчанию: None | устанавливает дополнительные монтирования (отдельные диски) для контейнера. В виде словаря, определяющего точки монтирования |
| nameserver | По умолчанию: None | устанавливает IP-адрес DNS-сервера для контейнера |
| netif | По умолчанию: None | устанавливает сетевые интерфейсы для контейнера. В виде словаря, определяющего интерфейсы. |
| node | По умолчанию: None | узел Proxmox VE, когда создается новая виртуальная машина требуется только для state=presentдля других состояний будет определяться автоматически |
| onboot | По умолчанию: нет | указывает, будет ли виртуальная машина запускаться при запуске системы |
| ostemplate | По умолчанию: None | шаблон для создания виртуальной машины требуется только для state=present |
| password | По умолчанию: None | корневой пароль экземпляра требуется только для state=present |
| pool (добавлен в 2.3) | По умолчанию: None | ресурсный пул Proxmox VE |
| pubkey (добавлен в 2.3) | По умолчанию: None | Открытый ключ для добавления в /root/.ssh/authorized_keys. Добавлено в Proxmox 4.2, игнорируется для более ранних версий |
| searchdomain | По умолчанию: None | устанавливает DNS-домен поиска для контейнера |
| state |
| Указывает желаемое состояние экземпляра |
| storage | По умолчанию: local | целевой накопитель |
| swap | По умолчанию: 0 | размер памяти подкачки в МБ для экземпляра |
| timeout | По умолчанию: 30 | таймаут для операций |
| unprivileged (добавлен в 2.3) | По умолчанию: нет | Указывает, должен ли контейнер быть без привилегий |
| validate_certs |
| включить/выключить проверку сертификатов HTTPS |
| vmid | По умолчанию: None | идентификатор экземпляра если не задано, будет получен следующий доступный ID виртуальной машины из ProxmoxAPI. если не задано, будет получено из PromoxAPI на основе имени хоста |
Примечания
Примечание
- Требуются модули proxmoxer и requests на хосте. Эти модули можно установить с помощью pip.
Примеры
# Create new container with minimal options
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_password: 1q2w3e
api_host: node1
password: 123456
hostname: example.org
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
# Create new container automatically selecting the next available vmid.
- proxmox:
node: 'uk-mc02'
api_user: 'root@pam'
api_password: '1q2w3e'
api_host: 'node1'
password: '123456'
hostname: 'example.org'
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
# Create new container with minimal options with force(it will rewrite existing container)
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_password: 1q2w3e
api_host: node1
password: 123456
hostname: example.org
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
force: yes
# Create new container with minimal options use environment PROXMOX_PASSWORD variable(you should export it before)
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_host: node1
password: 123456
hostname: example.org
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
# Create new container with minimal options defining network interface with dhcp
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_password: 1q2w3e
api_host: node1
password: 123456
hostname: example.org
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
netif: '{"net0":"name=eth0,ip=dhcp,ip6=dhcp,bridge=vmbr0"}'
# Create new container with minimal options defining network interface with static ip
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_password: 1q2w3e
api_host: node1
password: 123456
hostname: example.org
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
netif: '{"net0":"name=eth0,gw=192.168.0.1,ip=192.168.0.2/24,bridge=vmbr0"}'
# Create new container with minimal options defining a mount
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_password: 1q2w3e
api_host: node1
password: 123456
hostname: example.org
ostemplate: local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
mounts: '{"mp0":"local:8,mp=/mnt/test/"}'
# Create new container with minimal options defining a cpu core limit
- proxmox:
vmid: 100
node: uk-mc02
api_user: root@pam
api_password: 1q2w3e
api_host: node1
password: 123456
hostname: example.org
ostemplate: local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
cores: 2
# Start container
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
state: started
# Stop container
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
state: stopped
# Stop container with force
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
force: yes
state: stopped
# Restart container(stopped or mounted container you can't restart)
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
state: stopped
# Remove container
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
state: absent
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Сергей Антипов @UnderGreen
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/proxmox_module.html