Модуль community.proxmox.proxmox_storage — управление хранилищами в кластерах и узлах PVE

Примечание

Этот модуль входит в коллекцию community.proxmox (версия 1.6.0).

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

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

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

Добавлено в community.proxmox 1.3.0

Обзор
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Обзор

Управление хранилищами в кластерах и узлах PVE.

Требования

На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой хост кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
cephfs_options dictionary	Дополнительные сведения для добавления хранилища CephFS.
client_keyring string	Ключница клиента, которую следует использовать.
fs_name string	Имя файловой системы Ceph
monhost list / elements=string	Имя хоста или IP-адрес monhost.
password string	Пароль, необходимый для системы хранения данных.
path string	Путь, который будет использоваться в CephFS. По умолчанию: `"/"`
subdir string	Подкаталог, который будет использоваться в CephFS.
username string	Имя пользователя, необходимое для системы хранения данных.
cifs_options dictionary	Дополнительные сведения для добавления хранилища CIFS.
domain string	Домен, необходимый для общего ресурса CIFS.
password string	Пароль, необходимый для системы хранения данных.
server string	Имя хоста или IP-адрес удалённой системы хранения данных.
share string	Общий ресурс удалённой системы хранения данных, который следует использовать.
smb_version string	Минимальная версия SMB, которую следует использовать.
subdir string	Подкаталог, который будет использоваться в CIFS.
username string	Имя пользователя, необходимое для системы хранения данных.
content list / elements=string	Типы содержимого, которые следует использовать с этим типом хранилища. Обязателен, если `state=present`. Допустимые значения: `"images"` `"snippets"` `"import"` `"iso"` `"backup"` `"rootdir"` `"vztmpl"`
dir_options dictionary	Дополнительные сведения для добавления хранилища Directory.
path string	Путь к каталогу на узле (узлах).
iscsi_options dictionary	Дополнительные сведения для добавления хранилища iSCSI.
portal string	Имя хоста или IP-адрес удалённой системы хранения данных, используемый в качестве адреса портала.
target string	Необходимая цель iSCSI.
name string / обязательный	Имя хранилища, отображаемое в списке хранилищ.
nfs_options dictionary	Дополнительные сведения для добавления хранилища NFS.
export string	Необходимый путь экспорта NFS.
options string	Дополнительные параметры монтирования NFS (например, версия, pNFS).
server string	Имя хоста или IP-адрес удалённой системы хранения данных.
nodes list / elements=string	Список узлов Proxmox VE, на которых включено целевое хранилище. Обязателен, если `state=present`.
pbs_options dictionary	Дополнительные сведения для добавления Proxmox Backup Server в качестве хранилища.
datastore string	Необходимое хранилище данных Proxmox Backup Server.
fingerprint string	Необходимый отпечаток системы Proxmox Backup Server.
namespace string	Пространство имён Proxmox Backup Server, которое следует использовать.
password string	Пароль, необходимый для Proxmox Backup Server.
server string	Имя хоста или IP-адрес Proxmox Backup Server.
username string	Имя пользователя, необходимое для Proxmox Backup Server.
state string	Действие, выполняемое с указанным типом хранилища. Допустимые значения: `"present"` `"absent"`
type string / обязательный	Тип/протокол хранилища, используемый при его добавлении. Допустимые значения: `"cephfs"` `"cifs"` `"dir"` `"iscsi"` `"nfs"` `"pbs"` `"zfspool"`
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время значение по умолчанию — `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Допустимые значения: `false` `true`
zfspool_options dictionary	Дополнительные сведения для добавления хранилища ZFS.
pool string	Имя пула ZFS, который следует использовать.
sparse boolean	Использовать динамическое выделение ресурсов ZFS. Допустимые значения: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.proxmox.proxmox	Используйте `group/community.proxmox.proxmox` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff будут возвращены сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Add PBS storage to Proxmox VE Cluster
  community.proxmox.proxmox_storage:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    nodes: ["de-cgn01-virt01", "de-cgn01-virt02"]
    state: present
    name: backup-backupserver01
    type: pbs
    pbs_options:
      server: proxmox-backup-server.example.com
      username: backup@pbs
      password: password123
      datastore: backup
      fingerprint: "F3:04:D2:C1:33:B7:35:B9:88:D8:7A:24:85:21:DC:75:EE:7C:A5:2A:55:2D:99:38:6B:48:5E:CA:0D:E3:FE:66"
      export: "/mnt/storage01/b01pbs01"
    content: ["backup"]
- name: Add NFS storage to Proxmox VE Cluster
  community.proxmox.proxmox_storage:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    nodes: ["de-cgn01-virt01", "de-cgn01-virt02"]
    state: present
    name: net-nfsshare01
    type: nfs
    nfs_options:
      server: 10.10.10.94
      export: "/mnt/storage01/s01nfs01"
    content: ["rootdir", "images"]
- name: Add iSCSI storage to Proxmox VE Cluster
  community.proxmox.proxmox_storage:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    nodes: ["de-cgn01-virt01", "de-cgn01-virt02", "de-cgn01-virt03"]
    state: present
    type: iscsi
    name: net-iscsi01
    iscsi_options:
      portal: 10.10.10.94
      target: "iqn.2005-10.org.freenas.ctl:s01-isci01"
    content: ["rootdir", "images"]
- name: Remove storage from Proxmox VE Cluster
  community.proxmox.proxmox_storage:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    state: absent
    name: net-nfsshare01
    type: nfs
- name: Add ZFS storage to Proxmox VE Cluster
  community.proxmox.proxmox_storage:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    state: present
    name: zfspool-storage
    type: zfspool
    content: ["rootdir", "images"]
    zfspool_options:
      pool: rpool/data
      sparse: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
storage string	Сообщение о состоянии операции с хранилищем. Возвращается: при успехе Пример: `"Storage 'net-nfsshare01' created successfully."`

Авторы

Florian Paul Azim Hoberg (@gyptazy)

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

© 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_storage_module.html