Spec-Zone.ru › Ansible

Модуль community.general.lxd_project — управление проектами LXD

Примечание

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

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

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

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

Добавлено в community.general 4.8.0

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

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

  • Управление проектами LXD.

Параметры

Параметр

Комментарии

client_cert

псевдонимы: cert_file

путь

Путь к файлу сертификата клиента.

Если не задано, используется значение по умолчанию $HOME/.config/lxc/client.crt.

client_key

псевдонимы: key_file

путь

Путь к файлу ключа сертификата клиента.

Если не задано, используется значение по умолчанию $HOME/.config/lxc/client.key.

config

словарь

Конфигурация проекта (например, {"features.profiles": "true"}).

См. https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_get.

Если проект уже существует и его значение «config» в метаданных, полученных из GET /1.0/projects/<name> https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_get, отличается, этот модуль пытается применить конфигурацию https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_put.

description

строка

Описание проекта.

merge_project

логический

Объединять конфигурацию существующего проекта с новой требуемой конфигурацией, а не заменять её. Если после объединения конфигурация не изменится, изменения не вносятся.

Варианты:

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

name

строка / обязательный

Имя проекта.

new_name

строка

Новое имя проекта.

Если задан этот параметр, проект переименовывается в указанное имя.

См. https://documentation.ubuntu.com/lxd/en/latest/api/#/projects/project_post.

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 или URL HTTPS-сервера LXD.

По умолчанию: "unix:/var/lib/lxd/unix.socket"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: none

Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: none

В режиме diff возвращает сведения об изменениях (или возможных изменениях в check_mode).

Примечания

Примечание

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

Примеры

# An example for creating a project
- hosts: localhost
  connection: local
  tasks:
    - name: Create a project
      community.general.lxd_project:
        name: ansible-test-project
        state: present
        config: {}
        description: my new project

# An example for renaming a project
- hosts: localhost
  connection: local
  tasks:
    - name: Rename ansible-test-project to ansible-test-project-new-name
      community.general.lxd_project:
        name: ansible-test-project
        new_name: ansible-test-project-new-name
        state: present
        config: {}
        description: my new project

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

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

Ключ

Описание

actions

список / элементы=строка

Список действий, выполненных для проекта.

Возвращается: при успехе

Пример: ["create"]

logs

список / элементы=словарь

Журналы запросов и ответов.

Возвращается: если ansible-playbook запущен с параметром -vvvv.

request

словарь

HTTP-запрос, отправленный серверу LXD.

Возвращается: при успехе

json

строка

Тело HTTP-запроса в формате JSON.

Возвращается: при успехе

Пример: "(too long to be placed here)"

method

строка

Метод HTTP-запроса.

Возвращается: при успехе

Пример: "GET"

timeout

целое число

Время ожидания HTTP-запроса; null, если не задано.

Возвращается: при успехе

url

строка

Путь URL HTTP-запроса.

Возвращается: при успехе

Пример: "/1.0/projects/test-project"

response

словарь

HTTP-ответ, полученный от сервера LXD.

Возвращается: при успехе

json

строка

HTTP-ответ в формате JSON.

Возвращается: при успехе

Пример: "(too long to be placed here)"

type

строка

Тип выполненных действий; в настоящее время только sent request.

Возвращается: при успехе

Пример: "sent request"

old_state

строка

Предыдущее состояние проекта.

Возвращается: при успехе

Пример: "absent"

Авторы

  • Raymond Chang (@we10710aa)

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

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

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

Spec-Zone.ru

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