Spec-Zone.ru › Ansible

Модуль community.general.manageiq_provider — управление поставщиками в ManageIQ

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

dictionary

Информация о подключении к конечной точке оповещений.

auth_key

string

Токен аутентификации Bearer для конечной точки API поставщика. По умолчанию null.

certificate_authority

string

Строка пакета сертификатов CA с пользовательскими сертификатами. По умолчанию null.

hostname

string / обязательный

Имя хоста API поставщика.

password

string

Пароль аутентификации для конечной точки API поставщика. По умолчанию null.

path

string

ТРЕБУЕТСЯ документация.

port

integer

Порт API поставщика.

project

string

ТРЕБУЕТСЯ документация.

role

string

ТРЕБУЕТСЯ документация.

security_protocol

string

Способ использования SSL-сертификатов для HTTPS-запросов. По умолчанию null.

Варианты:

  • "ssl-with-validation"
  • "ssl-with-validation-custom-ca"
  • "ssl-without-validation"
  • "non-ssl"

subscription

string

ТРЕБУЕТСЯ документация.

uid_ems

string

ТРЕБУЕТСЯ документация.

userid

string

Идентификатор пользователя для аутентификации на конечной точке API поставщика. По умолчанию null.

validate_certs

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

boolean

Следует ли проверять SSL-сертификаты для HTTPS-запросов (устарело). По умолчанию true.

Варианты:

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

api_version

string

Версия API OpenStack Keystone.

Варианты:

  • "v2"
  • "v3"

azure_tenant_id

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

string

Идентификатор арендатора. По умолчанию null.

host_default_vnc_port_end

string

Последний порт в диапазоне VNC хоста.

host_default_vnc_port_start

string

Первый порт в диапазоне VNC хоста.

manageiq_connection

dictionary

Сведения о конфигурации подключения к ManageIQ.

ca_cert

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

string

Путь к файлу или каталогу пакета сертификатов CA.

password

string

Пароль ManageIQ. Если задана, используется переменная окружения MIQ_PASSWORD. В противном случае параметр обязателен, если не передан токен.

token

string

Токен ManageIQ. Если задана, используется переменная окружения MIQ_TOKEN. В противном случае параметр обязателен, если не переданы имя пользователя или пароль.

url

string

URL среды ManageIQ. Если задана, используется переменная окружения MIQ_URL. В противном случае URL необходимо указать.

username

string

Имя пользователя ManageIQ. Если задана, используется переменная окружения MIQ_USERNAME. В противном случае параметр обязателен, если не передан токен.

validate_certs

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

boolean

Следует ли проверять SSL-сертификаты для HTTPS-запросов.

Варианты:

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

metrics

dictionary

Информация о подключении к конечной точке метрик.

auth_key

string

Токен аутентификации Bearer для конечной точки API поставщика.

certificate_authority

string

Строка пакета сертификатов CA с пользовательскими сертификатами.

hostname

string / обязательный

Имя хоста API поставщика.

password

string

Пароль аутентификации для конечной точки API поставщика.

path

string

Имя базы данных для метрик oVirt. По умолчанию ovirt_engine_history.

port

integer

Порт API поставщика.

project

string

ТРЕБУЕТСЯ документация.

role

string

ТРЕБУЕТСЯ документация.

security_protocol

string

Способ использования SSL-сертификатов для HTTPS-запросов.

Варианты:

  • "ssl-with-validation"
  • "ssl-with-validation-custom-ca"
  • "ssl-without-validation"
  • "non-ssl"

subscription

string

ТРЕБУЕТСЯ документация.

uid_ems

string

ТРЕБУЕТСЯ документация.

userid

string

Идентификатор пользователя для аутентификации на конечной точке API поставщика.

validate_certs

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

boolean

Следует ли проверять SSL-сертификаты для HTTPS-запросов (устарело).

Варианты:

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

name

string / обязательный

Имя поставщика.

project

string

Идентификатор проекта Google Compute Engine.

provider

dictionary

Сведения о подключении к конечной точке по умолчанию; параметр обязателен, если state имеет значение true.

auth_key

string

Токен аутентификации Bearer для конечной точки API поставщика.

certificate_authority

string

Строка пакета сертификатов CA с пользовательскими сертификатами.

hostname

string / обязательный

Имя хоста API поставщика.

password

string

Пароль аутентификации для конечной точки API поставщика.

path

string

ТРЕБУЕТСЯ документация.

port

integer

Порт API поставщика.

project

string

ТРЕБУЕТСЯ документация.

role

string

ТРЕБУЕТСЯ документация.

security_protocol

string

Способ использования SSL-сертификатов для HTTPS-запросов.

Варианты:

  • "ssl-with-validation"
  • "ssl-with-validation-custom-ca"
  • "ssl-without-validation"
  • "non-ssl"

subscription

string

ТРЕБУЕТСЯ документация.

uid_ems

string

ТРЕБУЕТСЯ документация.

userid

string

Идентификатор пользователя для аутентификации на конечной точке API поставщика.

validate_certs

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

boolean

Следует ли проверять SSL-сертификаты для HTTPS-запросов (устарело).

Варианты:

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

provider_region

string

Имя региона поставщика для подключения (например, регион AWS для Amazon).

ssh_keypair

dictionary

Пара ключей SSH, используемая для SSH-подключений ко всем хостам этого поставщика.

auth_key

string

Закрытый ключ SSH.

certificate_authority

string

ТРЕБУЕТСЯ документация.

hostname

string / обязательный

Имя хоста Director.

password

string

ТРЕБУЕТСЯ документация.

path

string

ТРЕБУЕТСЯ документация.

port

integer

ТРЕБУЕТСЯ документация.

project

string

ТРЕБУЕТСЯ документация.

role

string

ТРЕБУЕТСЯ документация.

security_protocol

string

ТРЕБУЕТСЯ документация.

Варианты:

  • "ssl-with-validation"
  • "ssl-with-validation-custom-ca"
  • "ssl-without-validation"
  • "non-ssl"

subscription

string

Требуется документация.

uid_ems

string

Требуется документация.

userid

string

Имя пользователя SSH.

validate_certs

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

boolean

Проверять ли сертификаты для подключений.

Варианты:

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

state

string

absent — поставщик не должен существовать,

present — поставщик должен присутствовать,

refresh — поставщик обновляется.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "refresh"

subscription

string

Идентификатор подписки Microsoft Azure.

tenant_mapping_enabled

boolean

Включить ли сопоставление существующих арендаторов.

Варианты:

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

type

string

Тип поставщика.

Варианты:

  • "Openshift"
  • "Amazon"
  • "oVirt"
  • "VMware"
  • "Azure"
  • "Director"
  • "OpenStack"
  • "GCE"

zone

string

Имя зоны ManageIQ, управляющей поставщиком.

По умолчанию: "default"

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: отсутствует

Может работать в 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/manageiq_provider_module.html

Spec-Zone.ru

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