Модуль community.general.one_service – Развертывание и управление службами OpenNebula

Примечание

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

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

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

Для использования в playbook, укажите: community.general.one_service.

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

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

Управление службами OpenNebula

Параметры

Параметр	Комментарии
api_password string	Пароль пользователя для входа на сервер API OpenNebula OneFlow. Если не задан, используется значение переменной среды `ONEFLOW_PASSWORD`.
api_url string	URL сервера API OpenNebula OneFlow. Рекомендуется использовать HTTPS, чтобы имя пользователя/пароль не передавались по сети без шифрования. Если не задан, используется значение переменной среды `ONEFLOW_URL`.
api_username string	Имя пользователя для входа на сервер API OpenNebula OneFlow. Если не задан, используется значение переменной среды `ONEFLOW_USERNAME`.
cardinality integer	Количество виртуальных машин для указанной роли.
custom_attrs dictionary	Словарь пользовательских атрибутов ключ/значение, которые будут использоваться при создании новой службы. Значение по умолчанию: `{}`
force boolean	Принудительно установить новое значение cardinality, даже если оно выходит за пределы допустимых значений. Варианты: `false` ← (по умолчанию) `true`
group_id integer	ID группы, которая будет установлена в качестве группы службы.
mode string	Установить режим разрешений экземпляра службы в октетном формате, например `0600` для предоставления владельцу `use` и `manage`, а группе и другим ничего.
owner_id integer	ID пользователя, который будет установлен в качестве владельца службы.
role string	Имя роли, значение cardinality которой должно быть изменено.
service_id integer	ID экземпляра службы, которым вы хотите управлять.
service_name string	Имя экземпляра службы, которым вы хотите управлять.
state string	`present` - создать службу из шаблона, указанного с помощью `template_id` или `template_name`. `absent` - завершить работу экземпляра службы, указанного с помощью `template_id` или `template_name`. Варианты: `"present"` ← (по умолчанию) `"absent"`
template_id integer	ID шаблона службы, который будет использоваться для создания нового экземпляра службы.
template_name string	Имя шаблона службы, который будет использоваться для создания нового экземпляра службы.
unique boolean	Установка `unique=true` гарантирует, что при создании службы из шаблона, указанного с помощью `template_id` или `template_name`, работает только один экземпляр службы с именем, установленным с помощью `service_name`. См. примеры ниже. Варианты: `false` ← (по умолчанию) `true`
wait boolean	Ожидать, пока экземпляр не перейдет в состояние RUNNING после DEPLOYING или COOLDOWN после SCALING. Варианты: `false` ← (по умолчанию) `true`
wait_timeout integer	Сколько времени ждать, прежде чем ожидание прекратится, в секундах. Значение по умолчанию: `300`

Атрибуты

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

Примеры

- name: Instantiate a new service
  community.general.one_service:
    template_id: 90
  register: result

- name: Print service properties
  ansible.builtin.debug:
    msg: result

- name: Instantiate a new service with specified service_name, service group and mode
  community.general.one_service:
    template_name: 'app1_template'
    service_name: 'app1'
    group_id: 1
    mode: '660'

- name: Instantiate a new service with template_id and pass custom_attrs dict
  community.general.one_service:
    template_id: 90
    custom_attrs:
      public_network_id: 21
      private_network_id: 26

- name: Instantiate a new service 'foo' if the service doesn't already exist, otherwise do nothing
  community.general.one_service:
    template_id: 53
    service_name: 'foo'
    unique: true

- name: Delete a service by ID
  community.general.one_service:
    service_id: 153
    state: absent

- name: Get service info
  community.general.one_service:
    service_id: 153
  register: service_info

- name: Change service owner, group and mode
  community.general.one_service:
    service_name: 'app2'
    owner_id: 34
    group_id: 113
    mode: '600'

- name: Instantiate service and wait for it to become RUNNING
  community.general.one_service:
    template_id: 43
    service_name: 'foo1'

- name: Wait service to become RUNNING
  community.general.one_service:
    service_id: 112
    wait: true

- name: Change role cardinality
  community.general.one_service:
    service_id: 153
    role: bar
    cardinality: 5

- name: Change role cardinality and wait for it to be applied
  community.general.one_service:
    service_id: 112
    role: foo
    cardinality: 7
    wait: true

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

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

Ключ	Описание
group_id целое число	Идентификатор группы службы Возвращается: успех Пример: `1`
group_name строка	Название группы службы Возвращается: успех Пример: `"one-users"`
mode целое число	Режим службы Возвращается: успех Пример: `660`
owner_id целое число	Идентификатор владельца службы Возвращается: успех Пример: `143`
owner_name строка	Имя владельца службы Возвращается: успех Пример: `"ansible-test"`
roles список / элементы=строка	Список словарей ролей, каждая роль описывается именем, кардинальностью, состоянием и идентификаторами узлов Возвращается: успех Пример: `[{"cardinality": 1, "ids": [123, 456], "name": "foo", "state": "RUNNING"}, {"cardinality": 2, "ids": [452, 567, 746], "name": "bar", "state": "RUNNING"}]`
service_id целое число	Идентификатор службы Возвращается: успех Пример: `153`
service_name строка	Имя службы Возвращается: успех Пример: `"app1"`
state строка	Состояние экземпляра службы Возвращается: успех Пример: `"RUNNING"`

Авторы

Milan Ilic (@ilicmilan)

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

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