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

Примечание

Этот модуль является частью коллекции community.general collection (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

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

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

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

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

Параметры

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

Атрибуты

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

Примечания

Примечание

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

Примеры

# 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

Значения возврата

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

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

Авторы

Хироаки Накамура (@hnakamur)

Ссылки на сборку

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