proxmox – управление экземплярами в кластере Proxmox VE
Описание
- позволяет создавать/удалять/останавливать экземпляры в кластере Proxmox VE
- Начиная с Ansible 2.1, автоматически определяет тип контейнеризации (lxc для PVE 4, openvz для более старых версий)
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- proxmoxer
- python >= 2.7
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_host - / обязательно | хост кластера Proxmox VE | |
| api_password - | пароль для аутентификации можно использовать переменную окружения PROXMOX_PASSWORD | |
| api_user - / обязательно | пользователь для аутентификации | |
| cores - добавлено в 2.4 | Значение по умолчанию: 1 | Укажите количество ядер на сокет. |
| cpus - | Значение по умолчанию: 1 | количество выделенных процессоров для экземпляра |
| cpuunits - | Значение по умолчанию: 1000 | Вес процессора для виртуальной машины |
| disk - | Значение по умолчанию: 3 | размер жёсткого диска в ГБ для экземпляра |
| force boolean |
| принудительное выполнение операций может быть использовано только с состояниями present, stopped, restarted
с параметром force можно перезаписать существующий контейнер с состояниями stopped , restarted можно принудительно остановить экземпляр |
| hostname - | имя хоста экземпляра требуется только для state=present
должно быть уникальным, если не указан vmid | |
| ip_address - | указывается адрес, который будет назначен контейнеру | |
| memory - | Значение по умолчанию: 512 | размер памяти в МБ для экземпляра |
| mounts - | указываются дополнительные монтирования (отдельные диски) для контейнера. В виде хеша/словаря, определяющего точки монтирования | |
| nameserver - | устанавливает IP-адрес DNS-сервера для контейнера | |
| netif - | указываются сетевые интерфейсы для контейнера. В виде хеша/словаря, определяющего интерфейсы. | |
| node - | Узел Proxmox VE, когда создаётся новая виртуальная машина требуется только для state=present
для других состояний будет автоматически определён | |
| onboot boolean |
| указывается, будет ли виртуальная машина запускаться во время загрузки системы |
| ostemplate - | шаблон для создания виртуальной машины требуется только для state=present
| |
| password - | пароль для root экземпляра требуется только для state=present
| |
| pool - | ресурсный пул Proxmox VE | |
| pubkey - | открытый ключ для добавления в /root/.ssh/authorized_keys. Добавлено в Proxmox 4.2, игнорируется для более ранних версий | |
| searchdomain - | устанавливает домен DNS поиска для контейнера | |
| state - |
| Указывает желаемое состояние экземпляра |
| storage - | Значение по умолчанию: "local" | целевой накопитель |
| swap - | Значение по умолчанию: 0 | размер памяти подкачки в МБ для экземпляра |
| timeout - | Значение по умолчанию: 30 | таймаут для операций |
| unprivileged boolean |
| Указывает, должен ли контейнер быть непривилегированным |
| validate_certs boolean |
| включить/выключить проверку сертификатов HTTPS |
| vmid - | идентификатор экземпляра если не задан, будет получен следующий доступный идентификатор VM из 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 with 8GB
- 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
# Start container with mount. You should enter a 90-second timeout because servers with additional disks take longer to boot.
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
state: started
timeout: 90
# 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: restarted
# Remove container
- proxmox:
vmid: 100
api_user: root@pam
api_password: 1q2w3e
api_host: node1
state: absent
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Sergei Antipov (@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.9/modules/proxmox_module.html