community.general.jenkins_node 模块 – 管理 Jenkins 节点

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块，请参阅 需求 获取详细信息。

要在 playbook 中使用它，请指定： community.general.jenkins_node。

community.general 10.0.0 中的新增功能

概要

  • 使用 Jenkins REST API 管理 Jenkins 节点。

需求

执行此模块的主机需要以下需求。

  • python-jenkins >= 0.4.12

参数

参数

注释

labels

列表 / 元素=字符串

指定时，设置 Jenkins 节点标签。

name

字符串 / 必需

要管理的 Jenkins 节点的名称。

num_executors

整数

指定时，设置 Jenkins 节点的执行器数量。

offline_message

字符串

community.general 10.0.0 中新增

指定在配置 Jenkins 节点状态时要设置的脱机原因消息。

如果给出 offline_message 且请求的 state 不是 disabled，则会引发错误。

内部 offline_message 通过 toggleOffline API 设置，因此当节点已脱机（当前状态为 disabled）时更新消息是不可能的。在这种情况下，将发出警告。

state

字符串

指定 Jenkins 节点应该是 present（创建）、absent（删除）、enabled（在线）还是 disabled（脱机）。

选项

  • "enabled"

  • "disabled"

  • "present" ← (默认)

  • "absent"

token

字符串

用于与 Jenkins 服务器进行身份验证的 API 令牌。

url

字符串

Jenkins 服务器的 URL。

默认值： "https://:8080"

user

字符串

用于与 Jenkins 服务器进行身份验证的用户。

属性

属性

支持

描述

check_mode

支持：部分

检查模式无法显示尚未存在的节点的配置更改。

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: Create a Jenkins node using token authentication
  community.general.jenkins_node:
    url: https://: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

布尔值

任务是否配置了 Jenkins 节点。

返回：成功

created

布尔值

任务是否创建了 Jenkins 节点。

返回：成功

deleted

布尔值

任务是否删除了 Jenkins 节点。

返回：成功

disabled

布尔值

任务是否禁用了 Jenkins 节点。

返回：成功

enabled

布尔值

任务是否启用了 Jenkins 节点。

返回：成功

name

字符串

Jenkins 节点的名称。

返回：成功

示例： "my-node"

state

字符串

Jenkins 节点的状态。

返回：成功

示例： "present"

url

字符串

用于连接到 Jenkins 服务器的 URL。

返回：成功

示例： "https://jenkins.mydomain.com"

user

字符串

用于身份验证的用户。

返回：成功

示例： "jenkins"

作者

  • 康纳·牛顿 (@phyrwork)