community.general.manageiq_provider модуль — Управление провайдером в ManageIQ

Примечание

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

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

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

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

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

Обзор

Модуль manageiq_provider поддерживает добавление, обновление и удаление провайдера в ManageIQ.

Требования

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

manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/

Параметры

Параметр	Комментарии
alerts словарь	Информация о подключении к конечной точке оповещений.
auth_key строка	Токен аутентификации для конечной точки API поставщика. По умолчанию None.
certificate_authority строка	Строка с набором сертификатов CA с настраиваемыми сертификатами. По умолчанию None.
hostname строка / обязательно	Хостнейм API поставщика.
password строка	Пароль аутентификации для конечной точки API поставщика. По умолчанию None.
path строка	Требуется документация.
port целое число	Порт API поставщика.
project строка	Требуется документация.
role строка	Требуется документация.
security_protocol строка	Как использовать сертификаты SSL для запросов HTTPS. По умолчанию None. Варианты: `"ssl-with-validation"` `"ssl-with-validation-custom-ca"` `"ssl-without-validation"` `"non-ssl"`
subscription строка	Требуется документация.
uid_ems строка	Требуется документация.
userid строка	Идентификатор пользователя для аутентификации API поставщика. По умолчанию None.
validate_certs алиасы: verify_ssl логическое	Нужно ли проверять SSL-сертификаты для запросов HTTPS (устарело). По умолчанию True. Варианты: `false` `true` ← (по умолчанию)
api_version строка	Версия API OpenStack Keystone. По умолчанию None. Варианты: `"v2"` `"v3"`
azure_tenant_id алиасы: keystone_v3_domain_id строка	Идентификатор арендатора. По умолчанию None.
host_default_vnc_port_end строка	Последний порт в диапазоне VNC хоста. По умолчанию None.
host_default_vnc_port_start строка	Первый порт в диапазоне VNC хоста. По умолчанию None.
manageiq_connection словарь	Настройки подключения к ManageIQ.
ca_cert алиасы: ca_bundle_path строка	Путь к файлу или каталогу с сертификатами CA.
password строка	Пароль ManageIQ. `MIQ_PASSWORD` переменная среды, если установлена. В противном случае, обязательна, если не указан токен.
token строка	Токен ManageIQ. `MIQ_TOKEN` переменная среды, если установлена. В противном случае, обязательна, если не указаны имя пользователя или пароль.
url строка	URL окружения ManageIQ. `MIQ_URL` переменная среды, если установлена. В противном случае, требуется передать.

username string	Имя пользователя ManageIQ. `MIQ_USERNAME` переменная окружения, если задана. В противном случае, требуется, если не передан токен.
validate_certs aliases: verify_ssl boolean	Нужно ли проверять сертификаты SSL для запросов HTTPS. Варианты: `false` `true` ← (по умолчанию)
metrics dictionary	Информация о подключении к метрическому конечной точке.
auth_key string	Токен аутентификации API конечной точки провайдера. По умолчанию None.
certificate_authority string	Строка с набором CA сертификатов с настраиваемыми сертификатами. По умолчанию None.
hostname string / обязательно	Хост API провайдера.
password string	Пароль аутентификации API конечной точки провайдера. По умолчанию None.
path string	Имя базы данных для метрик oVirt. По умолчанию `ovirt_engine_history`.
port integer	Порт API провайдера.
project string	TODO требуется документация.
role string	TODO требуется документация.
security_protocol string	Как использовать SSL сертификаты для запросов HTTPS. По умолчанию None. Варианты: `"ssl-with-validation"` `"ssl-with-validation-custom-ca"` `"ssl-without-validation"` `"non-ssl"`
subscription string	TODO требуется документация.
uid_ems string	TODO требуется документация.
userid string	Идентификатор пользователя API конечной точки провайдера. По умолчанию None.
validate_certs aliases: verify_ssl boolean	Нужно ли проверять SSL сертификаты для запросов HTTPS (устарело). По умолчанию True. Варианты: `false` `true` ← (по умолчанию)
name string / обязательно	Имя провайдера.
project string	Идентификатор проекта Google Compute Engine. По умолчанию None.
provider dictionary	Информация о подключении к конечной точке по умолчанию, требуется если состояние true.
auth_key string	Токен аутентификации API конечной точки провайдера. По умолчанию None.
certificate_authority string	Строка с набором CA сертификатов с настраиваемыми сертификатами. По умолчанию None.
hostname string / обязательно	Хост API провайдера.
password string	Пароль аутентификации API конечной точки провайдера. По умолчанию None.
path string	TODO требуется документация.

port integer	Порт API провайдера.
project string	TODO needs documentation.
role string	TODO needs documentation.
security_protocol string	Как использовать SSL-сертификаты для HTTPS-запросов. По умолчанию None. Варианты: `"ssl-with-validation"` `"ssl-with-validation-custom-ca"` `"ssl-without-validation"` `"non-ssl"`
subscription string	TODO needs documentation.
uid_ems string	TODO needs documentation.
userid string	Идентификатор пользователя для аутентификации в конечной точке API провайдера. По умолчанию None.
validate_certs aliases: verify_ssl boolean	Необходимо ли проверять SSL-сертификаты для HTTPS-запросов (устарело). По умолчанию True. Варианты: `false` `true` ← (default)
provider_region string	Имя региона провайдера для подключения (например, регион AWS для Amazon).
ssh_keypair dictionary	Пара SSH-ключей, используемая для SSH-подключений ко всем хостам в этом провайдере.
auth_key string	Закрытый SSH-ключ.
certificate_authority string	TODO needs documentation.
hostname string / required	Имя хоста Director.
password string	TODO needs documentation.
path string	TODO needs documentation.
port integer	TODO needs documentation.
project string	TODO needs documentation.
role string	TODO needs documentation.
security_protocol string	TODO needs documentation. Варианты: `"ssl-with-validation"` `"ssl-with-validation-custom-ca"` `"ssl-without-validation"` `"non-ssl"`
subscription string	TODO needs documentation.
uid_ems string	TODO needs documentation.
userid string	Имя пользователя SSH.
validate_certs aliases: verify_ssl boolean	Необходимо ли проверять сертификаты для соединений. Варианты: `false` `true` ← (default)
state string	absent - провайдер не должен существовать, present - провайдер должен существовать, refresh - провайдер будет обновлен Варианты: `"absent"` `"present"` ← (default) `"refresh"`

подписка строка	Идентификатор подписки Microsoft Azure. По умолчанию None.
tenant_mapping_enabled логическое	Включить сопоставление существующих арендаторов. По умолчанию False. Варианты: `false` ← (по умолчанию) `true`
тип строка	Тип провайдера. Варианты: `"Openshift"` `"Amazon"` `"oVirt"` `"VMware"` `"Azure"` `"Director"` `"OpenStack"` `"GCE"`
зона строка	Имя зоны ManageIQ, которая будет управлять провайдером. По умолчанию: `"default"`

Атрибуты

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

Примеры

- name: Create a new provider in ManageIQ ('Hawkular' metrics)
  community.general.manageiq_provider:
    name: 'EngLab'
    type: 'OpenShift'
    state: 'present'
    provider:
      auth_key: 'topSecret'
      hostname: 'example.com'
      port: 8443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      auth_key: 'topSecret'
      role: 'hawkular'
      hostname: 'example.com'
      port: 443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    manageiq_connection:
      url: 'https://127.0.0.1:80'
      username: 'admin'
      password: 'password'
      validate_certs: true


- name: Update an existing provider named 'EngLab' (defaults to 'Prometheus' metrics)
  community.general.manageiq_provider:
    name: 'EngLab'
    type: 'Openshift'
    state: 'present'
    provider:
      auth_key: 'topSecret'
      hostname: 'next.example.com'
      port: 8443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      auth_key: 'topSecret'
      hostname: 'next.example.com'
      port: 443
      validate_certs: true
      security_protocol: 'ssl-with-validation-custom-ca'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    manageiq_connection:
      url: 'https://127.0.0.1'
      username: 'admin'
      password: 'password'
      validate_certs: true


- name: Delete a provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngLab'
    type: 'Openshift'
    state: 'absent'
    manageiq_connection:
      url: 'https://127.0.0.1'
      username: 'admin'
      password: 'password'
      validate_certs: true


- name: Create a new Amazon provider in ManageIQ using token authentication
  community.general.manageiq_provider:
    name: 'EngAmazon'
    type: 'Amazon'
    state: 'present'
    provider:
      hostname: 'amazon.example.com'
      userid: 'hello'
      password: 'world'
    manageiq_connection:
      url: 'https://127.0.0.1'
      token: 'VeryLongToken'
      validate_certs: true


- name: Create a new oVirt provider in ManageIQ
  community.general.manageiq_provider:
    name: 'RHEV'
    type: 'oVirt'
    state: 'present'
    provider:
      hostname: 'rhev01.example.com'
      userid: 'admin@internal'
      password: 'password'
      validate_certs: true
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      hostname: 'metrics.example.com'
      path: 'ovirt_engine_history'
      userid: 'user_id_metrics'
      password: 'password_metrics'
      validate_certs: true
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    manageiq_connection:
      url: 'https://127.0.0.1'
      username: 'admin'
      password: 'password'
      validate_certs: true

- name: Create a new VMware provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngVMware'
    type: 'VMware'
    state: 'present'
    provider:
      hostname: 'vcenter.example.com'
      host_default_vnc_port_start: 5800
      host_default_vnc_port_end: 5801
      userid: 'root'
      password: 'password'
    manageiq_connection:
      url: 'https://127.0.0.1'
      token: 'VeryLongToken'
      validate_certs: true

- name: Create a new Azure provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngAzure'
    type: 'Azure'
    provider_region: 'northeurope'
    subscription: 'e272bd74-f661-484f-b223-88dd128a4049'
    azure_tenant_id: 'e272bd74-f661-484f-b223-88dd128a4048'
    state: 'present'
    provider:
      hostname: 'azure.example.com'
      userid: 'e272bd74-f661-484f-b223-88dd128a4049'
      password: 'password'
    manageiq_connection:
      url: 'https://cf-6af0.rhpds.opentlc.com'
      username: 'admin'
      password: 'password'
      validate_certs: true

- name: Create a new OpenStack Director provider in ManageIQ with rsa keypair
  community.general.manageiq_provider:
    name: 'EngDirector'
    type: 'Director'
    api_version: 'v3'
    state: 'present'
    provider:
      hostname: 'director.example.com'
      userid: 'admin'
      password: 'password'
      security_protocol: 'ssl-with-validation'
      validate_certs: 'true'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    ssh_keypair:
      hostname: director.example.com
      userid: heat-admin
      auth_key: 'SecretSSHPrivateKey'

- name: Create a new OpenStack provider in ManageIQ with amqp metrics
  community.general.manageiq_provider:
    name: 'EngOpenStack'
    type: 'OpenStack'
    api_version: 'v3'
    state: 'present'
    provider_region: 'europe'
    tenant_mapping_enabled: 'False'
    keystone_v3_domain_id: 'mydomain'
    provider:
      hostname: 'openstack.example.com'
      userid: 'admin'
      password: 'password'
      security_protocol: 'ssl-with-validation'
      validate_certs: 'true'
      certificate_authority: |
        -----BEGIN CERTIFICATE-----
        FAKECERTsdKgAwI...
        -----END CERTIFICATE-----
    metrics:
      role: amqp
      hostname: 'amqp.example.com'
      security_protocol: 'non-ssl'
      port: 5666
      userid: admin
      password: password


- name: Create a new GCE provider in ManageIQ
  community.general.manageiq_provider:
    name: 'EngGoogle'
    type: 'GCE'
    provider_region: 'europe-west1'
    project: 'project1'
    state: 'present'
    provider:
      hostname: 'gce.example.com'
      auth_key: 'google_json_key'
      validate_certs: 'false'

Авторы

Daniel Korn (@dkorn)

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

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