Модуль community.general.lxd_profile — управление профилями LXD

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.lxd_profile.

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

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

Управление профилями LXD.

Параметры

Параметр	Комментарии
client_cert псевдонимы: cert_file путь	Путь к файлу сертификата клиента. Если не указано, значение по умолчанию — `$HOME/.config/lxc/client.crt`.
client_key псевдонимы: key_file путь	Путь к файлу ключа сертификата клиента. Если не указано, значение по умолчанию — `$HOME/.config/lxc/client.key`.
config словарь	Конфигурация экземпляра (например, `{"limits.memory": "4GB"}`). См. https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get. Если профиль уже существует, а значение `config` в его метаданных, полученных из GET /1.0/profiles/<name> https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get, отличается, модуль пытается применить конфигурации https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_put. Не все значения конфигурации можно применить к существующему профилю. Возможно, потребуется удалить профиль и создать его заново.
description строка	Описание профиля.
devices словарь	Устройства профиля (например, `{"rootfs": {"path": "/dev/kvm", "type": "unix-char"}`). См. https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_get.
merge_profile логическое значение добавлено в community.general 2.1.0	Объединить конфигурацию существующего профиля с новой желаемой конфигурацией, а не заменять её. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательный	Имя профиля.
new_name строка	Новое имя профиля. Если указан этот параметр, профилю присваивается новое имя. См. https://documentation.ubuntu.com/lxd/en/latest/api/#/profiles/profile_post.
project строка добавлено в community.general 4.8.0	Проект профиля. См. https://documentation.ubuntu.com/lxd/en/latest/projects/.
snap_url строка	Путь к сокету домена Unix, если LXD установлен с помощью менеджера пакетов snap. По умолчанию: `"unix:/var/snap/lxd/common/lxd/unix.socket"`
state строка	Задать состояние профиля. Варианты: `"present"` ← (по умолчанию) `"absent"`
trust_password строка	Пароль доверия клиента. Перед запуском этого модуля необходимо задать этот пароль на сервере LXD с помощью следующей команды: `lxc config set core.trust_password <some random password>`. См. https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/. Если задано `trust_password`, модуль отправляет запрос на аутентификацию перед отправкой любых запросов.
url строка	Путь к сокету домена Unix или HTTPS URL-адрес сервера LXD. По умолчанию: `"unix:/var/lib/lxd/unix.socket"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения о внесённых изменениях (или изменениях, которые, возможно, требуется внести в `check_mode`).

Примечания

Примечание

Имена профилей должны быть уникальными. Если попытаться создать профиль с именем, уже существующим в пространстве имён пользователей, модуль просто вернёт результат «без изменений».

Примеры

# An example for creating a profile
- hosts: localhost
  connection: local
  tasks:
    - name: Create a profile
      community.general.lxd_profile:
        name: macvlan
        state: present
        config: {}
        description: my macvlan profile
        devices:
          eth0:
            nictype: macvlan
            parent: br0
            type: nic

# An example for creating a profile in project mytestproject
- hosts: localhost
  connection: local
  tasks:
    - name: Create a profile
      community.general.lxd_profile:
        name: testprofile
        project: mytestproject
        state: present
        config: {}
        description: test profile in project mytestproject
        devices: {}

# An example for creating a profile via http connection
- hosts: localhost
  connection: local
  tasks:
    - name: Create macvlan profile
      community.general.lxd_profile:
        url: https://127.0.0.1:8443
        # These client_cert and client_key values are equal to the default values.
        # client_cert: "{{ lookup('env', 'HOME') }}/.config/lxc/client.crt"
        # client_key: "{{ lookup('env', 'HOME') }}/.config/lxc/client.key"
        trust_password: mypassword
        name: macvlan
        state: present
        config: {}
        description: my macvlan profile
        devices:
          eth0:
            nictype: macvlan
            parent: br0
            type: nic

# An example for modify/merge a profile
- hosts: localhost
  connection: local
  tasks:
    - name: Merge a profile
      community.general.lxd_profile:
        merge_profile: true
        name: macvlan
        state: present
        config: {}
        description: my macvlan profile
        devices:
          eth0:
            nictype: macvlan
            parent: br0
            type: nic

# An example for deleting a profile
- hosts: localhost
  connection: local
  tasks:
    - name: Delete a profile
      community.general.lxd_profile:
        name: macvlan
        state: absent

# An example for renaming a profile
- hosts: localhost
  connection: local
  tasks:
    - name: Rename a profile
      community.general.lxd_profile:
        name: macvlan
        new_name: macvlan2
        state: present

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

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

Ключ	Описание
actions список / элементы=строка	Список действий, выполненных для профиля. Возвращается: при успехе Пример: `["create"]`
logs список / элементы=строка	Журналы запросов и ответов. Возвращается: если ansible-playbook запущен с параметром -vvvv. Пример: `["(too long to be placed here)"]`
old_state строка	Предыдущее состояние профиля. Возвращается: при успехе Пример: `"absent"`

Авторы

Hiroaki Nakamura (@hnakamur)

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

© 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/general/lxd_profile_module.html