Модуль community.general.jenkins_node — управление узлами Jenkins

Примечание

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

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

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

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

Добавлено в community.general 10.0.0

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

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

Управление узлами Jenkins с помощью REST API Jenkins.

Требования

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

python-jenkins >= 0.4.12

Параметры

Параметр	Комментарии
labels list / elements=string	Если указано, задаёт метки узла Jenkins.
name string / обязательный	Имя управляемого узла Jenkins.
num_executors integer	Если указано, задаёт количество исполнителей узла Jenkins.
offline_message string добавлено в community.general 10.0.0	Указывает сообщение с причиной отключения, которое будет задано при настройке состояния узла Jenkins. Если задано `offline_message`, а запрошенное `state` не равно `disabled`, возникает ошибка. Внутренне `offline_message` задаётся с помощью API `toggleOffline`, поэтому изменить сообщение, когда узел уже отключён (текущее состояние `disabled`), невозможно. В этом случае выводится предупреждение.
state string	Указывает, должен ли узел Jenkins быть `present` (создан), `absent` (удалён), `enabled` (в сети) или `disabled` (не в сети). Варианты: `"enabled"` `"disabled"` `"present"` ← (по умолчанию) `"absent"`
token string	Токен API для аутентификации на сервере Jenkins.
url string	URL сервера Jenkins. По умолчанию: `"http://localhost:8080"`
user string	Пользователь для аутентификации на сервере Jenkins.

Атрибуты

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

Примеры

- name: Create a Jenkins node using token authentication
  community.general.jenkins_node:
    url: http://localhost:8080
    user: jenkins
    token: 11eb751baabb66c4d1cb8dc4e0fb142cde
    name: my-node
    state: present

- name: Set number of executors on Jenkins node
  community.general.jenkins_node:
    name: my-node
    state: present
    num_executors: 4

- name: Set labels on Jenkins node
  community.general.jenkins_node:
    name: my-node
    state: present
    labels:
      - label-1
      - label-2
      - label-3

- name: Set Jenkins node offline with offline message.
  community.general.jenkins_node:
    name: my-node
    state: disabled
    offline_message: >-
      This node is offline for some reason.

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

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

Ключ	Описание
configured boolean	Указывает, была ли настроена задача узла Jenkins. Возвращается: при успехе
created boolean	Указывает, был ли создан задачей узел Jenkins. Возвращается: при успехе
deleted boolean	Указывает, был ли удалён задачей узел Jenkins. Возвращается: при успехе
disabled boolean	Указывает, был ли отключён задачей узел Jenkins. Возвращается: при успехе
enabled boolean	Указывает, был ли включён задачей узел Jenkins. Возвращается: при успехе
name string	Имя узла Jenkins. Возвращается: при успехе Пример: `"my-node"`
state string	Состояние узла Jenkins. Возвращается: при успехе Пример: `"present"`
url string	URL, использованный для подключения к серверу Jenkins. Возвращается: при успехе Пример: `"https://jenkins.mydomain.com"`
user string	Пользователь, использованный для аутентификации. Возвращается: при успехе Пример: `"jenkins"`

Авторы

Connor Newton (@phyrwork)

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

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