Spec-Zone.ru › Ansible 2.4

os_server_group - Управление группами серверов OpenStack

Новая версия с 2.2.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Добавление или удаление групп серверов из OpenStack.

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.6
  • python >= 2.7
  • shade

Параметры

параметр обязательно по умолчанию выбор комментарии
api_timeout
нет None
Сколько времени слой сокетов должен ждать перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку запросов.
auth
нет
Словарь, содержащий информацию об авторизации, как требуется стратегией плагина авторизации облака. Для стандартного плагина password это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type
нет password
Имя плагина авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone
нет
Игнорируется. Присутствует для обратной совместимости
cacert
нет None
Путь к пакету CA Cert, который может использоваться для проверки SSL запросов к API.
cert
нет None
Путь к клиенту сертификат, который будет использоваться в рамках SSL транзакции.
cloud
нет
Имя облака для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*.
endpoint_type
нет public
  • public
  • internal
  • admin
Тип URL конечной точки для извлечения из каталога служб.
key
нет None
Путь к ключу клиента для использования в рамках SSL транзакции.
name
да
Имя группы серверов.
policies
нет
Список одного или нескольких имен политики, которые нужно ассоциировать с группой серверов. Список должен содержать по крайней мере одно имя политики. В настоящее время допустимые имена политик — anti-affinity, affinity, soft-anti-affinity и soft-affinity.
region_name
нет
Имя региона.
state
нет present
  • present
  • absent
Указывает желаемое состояние ресурса. Когда state равен 'present', тогда policies является обязательным.
timeout
нет 180
Сколько времени Ansible должен ждать запрашиваемого ресурса.
validate_certs
нет
Нужно ли проверять SSL запросы API. До версии 2.3 по умолчанию было True.
псевдонимы: verify
wait
нет yes
  • yes
  • no
Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен.

Примеры

# Create a server group with 'affinity' policy.
- os_server_group:
    state: present
    auth:
      auth_url: https://api.cloud.catalyst.net.nz:5000/v2.0
      username: admin
      password: admin
      project_name: admin
    name: my_server_group
    policies:
      - affinity

# Delete 'my_server_group' server group.
- os_server_group:
    state: absent
    auth:
      auth_url: https://api.cloud.catalyst.net.nz:5000/v2.0
      username: admin
      password: admin
      project_name: admin
    name: my_server_group

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

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

имя описание возвращается тип пример
id
Уникальный UUID.
успех строка
members
Список членов группы серверов.
успех список
metadata
Пары ключ-значение метаданных.
успех словарь
name
Имя группы серверов.
успех строка
policies
Список имен одной или нескольких политик группы серверов.
успех список
project_id
ID проекта, владеющего группой серверов.
успех строка
user_id
ID пользователя, владеющего группой серверов.
успех строка

Примечания

Примечание

  • Стандартные переменные среды OpenStack, такие как OS_USERNAME , могут использоваться вместо явного указания значений.
  • Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в play. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Для помощи в разработке модулей, если вы так решите, пожалуйста, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_server_group_module.html

Spec-Zone.ru

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