модуль theforeman.foreman.compute_resource — управление вычислительными ресурсами

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.compute_resource.

Добавлено в theforeman.foreman 1.0.0

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

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

Создание, обновление и удаление вычислительных ресурсов

Псевдонимы: foreman_compute_resource

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_CA_PATH`.
description string	Описание вычислительного ресурса
locations list / elements=string	Список расположений, которым должна быть назначена сущность
name string / обязательный	Имя вычислительного ресурса
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / elements=string	Список организаций, которым должна быть назначена сущность
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_PASSWORD`.
provider string	Поставщик вычислительного ресурса. Обязательный параметр, если state=present_with_defaults. Варианты: `"vmware"` `"libvirt"` `"ovirt"` `"proxmox"` `"EC2"` `"AzureRm"` `"GCE"` `"Openstack"`
provider_params dictionary	Параметр, специфичный для поставщика вычислительного ресурса. Обязательный параметр, если state=present_with_defaults.
app_ident string	Идентификатор клиента AzureRM
caching_enabled boolean	Включить кэширование для provider=vmware Варианты: `false` `true`
cloud string добавлено в theforeman.foreman 2.1.0	Облако для provider=AzureRm Варианты: `"azure"` `"azureusgovernment"` `"azurechina"` `"azuregermancloud"`
datacenter string	Дата-центр, в котором находится вычислительный ресурс; параметр неприменим для provider=libvirt
display_type string	Тип дисплея для удалённой консоли; применимо только для provider=libvirt
domain string	Домен аутентификации пользователей; применимо только для provider=Openstack
email string	Адрес электронной почты для provider=GCE
key_path string	Путь к сертификату для provider=GCE
keyboard_layout string добавлено в theforeman.foreman 2.0.0	Раскладка клавиатуры VNC по умолчанию для provider=ovirt Варианты: `"ar"` `"da"` `"de"` `"de-ch"` `"en-gb"` `"en-us"` `"es"` `"et"` `"fi"` `"fo"` `"fr"` `"fr-be"` `"fr-ca"` `"fr-ch"` `"hr"` `"hu"` `"is"` `"it"` `"ja"` `"lt"` `"lv"` `"mk"` `"nl"` `"nl-be"` `"no"` `"pl"` `"pt"` `"pt-br"` `"ru"` `"sl"` `"sv"` `"th"` `"tr"`
ovirt_quota string	Идентификатор квоты oVirt; применимо только для provider=ovirt
password string	Пароль для подключения к вычислительному ресурсу; параметр неприменим для provider=libvirt
project string	Идентификатор проекта для provider=GCE
project_domain_id string	Идентификатор домена проекта; применимо только для provider=Openstack
project_domain_name string	Имя домена проекта; применимо только для provider=Openstack
public_key string добавлено в theforeman.foreman 2.0.0	Центры сертификации X509; применимо только для provider=ovirt
region string	Регион AWS, регион Azure
set_console_password boolean добавлено в theforeman.foreman 2.0.0	Установить случайно сгенерированный пароль для подключения к дисплею для provider=vmware и provider=libvirt Варианты: `false` `true`
ssl_verify_peer boolean	Проверять SSL для поставщика provider=proxmox Варианты: `false` `true`
sub_id string добавлено в theforeman.foreman 2.1.0	Идентификатор подписки для provider=AzureRm
tenant string	Арендатор AzureRM, имя проекта OpenStack
url string	URL-адрес вычислительного ресурса
use_v4 boolean	Использовать API oVirt версии 4; применимо только для provider=ovirt Варианты: `false` `true`
user string	Имя пользователя для подключения к вычислительному ресурсу; параметр неприменим для provider=libvirt
zone string	Зона для provider=GCE
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности `present_with_defaults` гарантирует наличие сущности, но не обновляет существующие сущности Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
updated_name string	Новое имя вычислительного ресурса
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Для этого необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя для доступа к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create libvirt compute resource
  theforeman.foreman.compute_resource:
    name: example_compute_resource
    locations:
      - Munich
    organizations:
      - ACME
    provider: libvirt
    provider_params:
      url: qemu+ssh://root@libvirt.example.com/system
      display_type: spice
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: Update libvirt compute resource
  theforeman.foreman.compute_resource:
    name: example_compute_resource
    description: updated compute resource
    locations:
      - Munich
    organizations:
      - ACME
    provider: libvirt
    provider_params:
      url: qemu+ssh://root@libvirt.example.com/system
      display_type: spice
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: Delete libvirt compute resource
  theforeman.foreman.compute_resource:
    name: example_compute_resource
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: absent

- name: Create vmware compute resource
  theforeman.foreman.compute_resource:
    name: example_compute_resource
    locations:
      - Munich
    organizations:
      - ACME
    provider: vmware
    provider_params:
      caching_enabled: false
      url: vsphere.example.com
      user: admin
      password: secret
      datacenter: ax01
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: Create ovirt compute resource
  theforeman.foreman.compute_resource:
    name: ovirt_compute_resource
    locations:
      - France/Toulouse
    organizations:
      - Example Org
    provider: ovirt
    provider_params:
      url: ovirt.example.com
      user: ovirt-admin@example.com
      password: ovirtsecret
      datacenter: aa92fb54-0736-4066-8fa8-b8b9e3bd75ac
      ovirt_quota: 24868ab9-c2a1-47c3-87e7-706f17d215ac
      use_v4: true
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: Create proxmox compute resource
  theforeman.foreman.compute_resource:
    name: proxmox_compute_resource
    locations:
      - Munich
    organizations:
      - ACME
    provider: proxmox
    provider_params:
      url: https://proxmox.example.com:8006/api2/json
      user: root@pam
      password: secretpassword
      ssl_verify_peer: true
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: create EC2 compute resource
  theforeman.foreman.compute_resource:
    name: EC2_compute_resource
    description: EC2
    locations:
      - AWS
    organizations:
      - ACME
    provider: EC2
    provider_params:
      user: AWS_ACCESS_KEY
      password: AWS_SECRET_KEY
      region: eu-west-1
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: create Azure compute resource
  theforeman.foreman.compute_resource:
    name: AzureRm_compute_resource
    description: AzureRm
    locations:
      - Azure
    organizations:
      - ACME
    provider: AzureRm
    provider_params:
      sub_id: SUBSCRIPTION_ID
      tenant: TENANT_ID
      app_ident: CLIENT_ID
      password: CLIENT_SECRET
      region: westeurope
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: create GCE compute resource
  theforeman.foreman.compute_resource:
    name: GCE compute resource
    description: Google Cloud Engine
    locations:
      - GCE
    organizations:
      - ACME
    provider: GCE
    provider_params:
      project: orcharhino
      email: myname@atix.de
      key_path: "/usr/share/foreman/gce_orcharhino_key.json"
      zone: europe-west3-b
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: create Openstack compute resource
  theforeman.foreman.compute_resource:
    name: Openstack compute resource
    description: Openstack
    locations:
      - DC1
    organizations:
      - ACME
    provider: Openstack
    provider_params:
      url: "https://Openstack.example.com:5000/v3"
      user: admin
      password: secret
      tenant: "MyProject"
      domain: "example.com"
      project_domain_name: "example.com"
      project_domain_id: "0123456789a0123456789b0123456789"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

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

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

Ключ	Описание
entity dictionary	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успешном выполнении
compute_resources list / elements=dictionary	Список вычислительных ресурсов. Возвращается: при успешном выполнении

Авторы

Philipp Joos (@philippj)
Baptiste Agasse (@bagasse)
Manisha Singhal (@Manisha15) ATIX AG
Mark Hlawatschek (@hlawatschek) ATIX AG

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

© 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/theforeman/foreman/compute_resource_module.html