Spec-Zone.ru › Ansible

Подключение community.proxmox.proxmox_pct_remote — выполнение задач в экземплярах контейнеров Proxmox LXC с помощью pct CLI через SSH

Примечание

Этот плагин подключения входит в коллекцию community.proxmox (версия 1.6.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.proxmox. Для работы с этим плагином подключения требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.proxmox.proxmox_pct_remote.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры

Краткое описание

  • Выполняет команды, а также копирует файлы в существующий контейнер Proxmox LXC или извлекает их из него с помощью pct CLI через SSH.
  • Для подключения к хосту Proxmox используется реализация SSH на Python (Paramiko).

Требования

Следующие требования необходимы на локальном управляющем узле, который выполняет это подключение.

  • paramiko

Параметры

Параметр

Комментарии

banner_timeout

float

Задает время ожидания (в секундах) появления баннера SSH. Этот параметр поддерживается в Paramiko версии 1.15.0 и новее.

По умолчанию: 30.0

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
banner_timeout = 30.0
  • Переменная среды: ANSIBLE_PARAMIKO_BANNER_TIMEOUT

forward_agent

boolean

Включает переадресацию агента SSH.

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
forward_agent = false
  • Переменная среды: ANSIBLE_PARAMIKO_FORWARD_AGENT

host_key_auto_add

boolean

Автоматически добавляет ключи хостов в ~/.ssh/known_hosts.

Варианты:

  • false
  • true

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
host_key_auto_add = VALUE
  • Переменная среды: ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD

host_key_checking

boolean

Установите значение false, если хотите отключить проверку ключа хоста инструментами, которые Ansible использует для подключения к хосту.

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Параметры INI:

    [defaults]
host_key_checking = true

    [paramiko_connection]
host_key_checking = true
  • Переменная среды: ANSIBLE_HOST_KEY_CHECKING
  • Переменная среды: ANSIBLE_SSH_HOST_KEY_CHECKING
  • Переменная среды: ANSIBLE_PARAMIKO_HOST_KEY_CHECKING
  • Переменная: ansible_host_key_checking
  • Переменная: ansible_ssh_host_key_checking
  • Переменная: ansible_paramiko_host_key_checking

lock_file_timeout

integer

Количество секунд, по истечении которых плагин прекращает попытки записать файл блокировки при записи известных ключей хостов SSH.

По умолчанию: 60

Конфигурация:

  • Переменная среды: ANSIBLE_LOCK_FILE_TIMEOUT
  • Переменная: ansible_lock_file_timeout

look_for_keys

boolean

Установите значение false, чтобы отключить поиск файлов закрытых ключей в ~/.ssh/.

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
look_for_keys = true
  • Переменная среды: ANSIBLE_PARAMIKO_LOOK_FOR_KEYS

password

string

Секрет, используемый для входа на сервер SSH или в качестве парольной фразы для закрытых ключей SSH, которым она необходима.

Можно задать из командной строки с помощью параметра --ask-pass.

Конфигурация:

  • Переменная: ansible_password
  • Переменная: ansible_ssh_pass
  • Переменная: ansible_ssh_password
  • Переменная: ansible_paramiko_pass
  • Переменная: ansible_paramiko_password

port

integer

Удаленный порт для подключения.

По умолчанию: 22

Конфигурация:

  • Параметры INI:

    [defaults]
remote_port = 22

    [paramiko_connection]
remote_port = 22
  • Переменная среды: ANSIBLE_REMOTE_PORT
  • Переменная среды: ANSIBLE_REMOTE_PARAMIKO_PORT
  • Ключевое слово: port
  • Переменная: ansible_port
  • Переменная: ansible_ssh_port
  • Переменная: ansible_paramiko_port

private_key_file

string

Путь к файлу закрытого ключа, используемому для аутентификации.

Конфигурация:

  • Параметры INI:

    [defaults]
private_key_file = VALUE

    [paramiko_connection]
private_key_file = VALUE
  • Переменная среды: ANSIBLE_PRIVATE_KEY_FILE
  • Переменная среды: ANSIBLE_PARAMIKO_PRIVATE_KEY_FILE
  • Аргумент CLI: --private-key
  • Переменная: ansible_private_key_file
  • Переменная: ansible_ssh_private_key_file
  • Переменная: ansible_paramiko_private_key_file

proxmox_become_method

string

Команда повышения привилегий, используемая в Proxmox

По умолчанию: "sudo"

Конфигурация:

  • Переменная: proxmox_become_method

proxy_command

string

Параметры прокси для подключения через промежуточный хост.

По умолчанию: ""

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
proxy_command = ""
  • Переменная среды: ANSIBLE_PARAMIKO_PROXY_COMMAND
  • Переменная: ansible_paramiko_proxy_command

pty

boolean

Для sudo обычно требуется PTY; значение true выделяет PTY, а false не выделяет PTY.

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
pty = true
  • Переменная среды: ANSIBLE_PARAMIKO_PTY

record_host_keys

boolean

Сохраняет ключи хостов в файл.

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
record_host_keys = true
  • Переменная среды: ANSIBLE_PARAMIKO_RECORD_HOST_KEYS

remote_addr

string

Адрес удаленной целевой системы.

По умолчанию: "inventory_hostname"

Конфигурация:

  • Переменная: inventory_hostname
  • Переменная: ansible_host
  • Переменная: ansible_ssh_host
  • Переменная: ansible_paramiko_host

remote_user

string

Пользователь, от имени которого выполняется вход и аутентификация.

Можно задать из командной строки с помощью параметра --user или -u.

Конфигурация:

  • Параметры INI:

    [defaults]
remote_user = VALUE

    [paramiko_connection]
remote_user = VALUE
  • Переменная среды: ANSIBLE_REMOTE_USER
  • Переменная среды: ANSIBLE_PARAMIKO_REMOTE_USER
  • Ключевое слово: remote_user
  • Переменная: ansible_user
  • Переменная: ansible_ssh_user
  • Переменная: ansible_paramiko_user

timeout

integer

Количество секунд, по истечении которых плагин прекращает попытки установить TCP-соединение.

По умолчанию: 10

Конфигурация:

  • Параметры INI:

    [defaults]
timeout = 10

    [ssh_connection]
timeout = 10

    [paramiko_connection]
timeout = 10
  • Переменная среды: ANSIBLE_TIMEOUT
  • Переменная среды: ANSIBLE_SSH_TIMEOUT
  • Переменная среды: ANSIBLE_PARAMIKO_TIMEOUT
  • Аргумент CLI: --timeout
  • Переменная: ansible_ssh_timeout
  • Переменная: ansible_paramiko_timeout

use_persistent_connections

boolean

Включает или отключает использование постоянных подключений.

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Параметр INI:

    [defaults]
use_persistent_connections = false
  • Переменная среды: ANSIBLE_USE_PERSISTENT_CONNECTIONS

use_rsa_sha2_algorithms

boolean

Включать ли алгоритмы RSA SHA2 для открытых ключей и ключей хостов.

В версиях Paramiko ниже 2.9 это влияет только на ключи хостов.

Чтобы поведение соответствовало Paramiko<2.9, установите значение false.

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Параметр INI:

    [paramiko_connection]
use_rsa_sha2_algorithms = true
  • Переменная среды: ANSIBLE_PARAMIKO_USE_RSA_SHA2_ALGORITHMS
  • Переменная: ansible_paramiko_use_rsa_sha2_algorithms

vmid

integer

Идентификатор контейнера LXC

Конфигурация:

  • Переменная: proxmox_vmid

Примечание

Для каждого типа записей конфигурации, перечисленного выше (переменная Ansible, переменная среды и т. д.), задан порядок приоритета от низшего к высшему. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низшего к высшему. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

  • Если вы используете этот плагин НЕ от имени пользователя root, на Proxmox необходимо установить механизм повышения привилегий, например sudo, и настроить его так, чтобы команда выполнялась без запроса пароля. В контейнере должна быть оболочка, например sh, а команда cat должна быть доступна в PATH, чтобы этот плагин работал.

Примеры

# --------------------------------------------------------------
# Setup sudo with password less access to pct for user 'ansible':
# --------------------------------------------------------------
#
# Open a Proxmox root shell and execute:
# $ useradd -d /opt/ansible-pct -r -m -s /bin/sh ansible
# $ mkdir -p /opt/ansible-pct/.ssh
# $ ssh-keygen -t ed25519 -C 'ansible' -N "" -f /opt/ansible-pct/.ssh/ansible <<< y > /dev/null
# $ cat /opt/ansible-pct/.ssh/ansible
# $ mv /opt/ansible-pct/.ssh/ansible.pub /opt/ansible-pct/.ssh/authorized-keys
# $ rm /opt/ansible-pct/.ssh/ansible*
# $ chown -R ansible:ansible /opt/ansible-pct/.ssh
# $ chmod 700 /opt/ansible-pct/.ssh
# $ chmod 600 /opt/ansible-pct/.ssh/authorized-keys
# $ echo 'ansible ALL = (root) NOPASSWD: /usr/sbin/pct' > /etc/sudoers.d/ansible_pct
#
# Save the displayed private key and add it to your ssh-agent
#
# Or use ansible:
# ---
# - name: Setup ansible-pct user and configure environment on Proxmox host
#   hosts: proxmox
#   become: true
#   gather_facts: false
#
#   tasks:
#     - name: Create ansible user
#       ansible.builtin.user:
#         name: ansible
#         comment: Ansible User
#         home: /opt/ansible-pct
#         shell: /bin/sh
#         create_home: true
#         system: true
#
#     - name: Create .ssh directory
#       ansible.builtin.file:
#         path: /opt/ansible-pct/.ssh
#         state: directory
#         owner: ansible
#         group: ansible
#         mode: '0700'
#
#     - name: Generate SSH key for ansible user
#       community.crypto.openssh_keypair:
#         path: /opt/ansible-pct/.ssh/ansible
#         type: ed25519
#         comment: 'ansible'
#         force: true
#         mode: '0600'
#         owner: ansible
#         group: ansible
#
#     - name: Set public key as authorized key
#       ansible.builtin.copy:
#         src: /opt/ansible-pct/.ssh/ansible.pub
#         dest: /opt/ansible-pct/.ssh/authorized-keys
#         remote_src: yes
#         owner: ansible
#         group: ansible
#         mode: '0600'
#
#     - name: Add sudoers entry for ansible user
#       ansible.builtin.copy:
#         content: 'ansible ALL = (root) NOPASSWD: /usr/sbin/pct'
#         dest: /etc/sudoers.d/ansible_pct
#         owner: root
#         group: root
#         mode: '0440'
#
#     - name: Fetch private SSH key to localhost
#       ansible.builtin.fetch:
#         src: /opt/ansible-pct/.ssh/ansible
#         dest: ~/.ssh/proxmox_ansible_private_key
#         flat: yes
#         fail_on_missing: true
#
#     - name: Clean up generated SSH keys
#       ansible.builtin.file:
#         path: /opt/ansible-pct/.ssh/ansible*
#         state: absent
#
# - name: Configure private key permissions on localhost
#   hosts: localhost
#   tasks:
#     - name: Set permissions for fetched private key
#       ansible.builtin.file:
#         path: ~/.ssh/proxmox_ansible_private_key
#         mode: '0600'
#
# --------------------------------
# Static inventory file: hosts.yml
# --------------------------------
# all:
#   children:
#     lxc:
#       hosts:
#         container-1:
#           ansible_host: 10.0.0.10
#           proxmox_vmid: 100
#           ansible_connection: community.proxmox.proxmox_pct_remote
#           ansible_user: ansible
#         container-2:
#           ansible_host: 10.0.0.10
#           proxmox_vmid: 200
#           ansible_connection: community.proxmox.proxmox_pct_remote
#           ansible_user: ansible
#     proxmox:
#       hosts:
#         proxmox-1:
#           ansible_host: 10.0.0.10
#
#
# ---------------------------------------------
# Dynamic inventory file: inventory.proxmox.yml
# ---------------------------------------------
# plugin: community.proxmox.proxmox
# url: https://10.0.0.10:8006
# validate_certs: false
# user: ansible@pam
# token_id: ansible
# token_secret: !vault |
#           $ANSIBLE_VAULT;1.1;AES256
#           ...

# want_facts: true
# exclude_nodes: true
# filters:
#   - proxmox_vmtype == "lxc"
# want_proxmox_nodes_ansible_host: false
# compose:
#   ansible_host: "'10.0.0.10'"
#   ansible_connection: "'community.proxmox.proxmox_pct_remote'"
#   ansible_user: "'ansible'"
#
#
# ----------------------
# Playbook: playbook.yml
# ----------------------
---
- hosts: lxc
  # On nodes with many containers you might want to deactivate the devices facts
  # or set `gather_facts: false` if you don't need them.
  # More info on gathering fact subsets:
  # https://docs.ansible.com/ansible/latest/collections/ansible/builtin/setup_module.html
  #
  # gather_facts: true
  #   gather_subset:
  #     - "!devices"
  tasks:
    - name: Ping LXC container
      ansible.builtin.ping:

Авторы

  • Nils Stein (@mietzen)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Сообщить о проблеме
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/proxmox/proxmox_pct_remote_connection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API