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

list / elements=string

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

name

string / required

要管理的 Jenkins 节点的名称。

num_executors

integer

指定后，设置 Jenkins 节点执行器计数。

offline_message

string

在 community.general 10.0.0 中添加

指定配置 Jenkins 节点状态时要设置的离线原因消息。

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

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

state

string

指定 Jenkins 节点应为 present（已创建）、absent（已删除）、enabled（在线）还是 disabled（离线）。

选择

  • "enabled"

  • "disabled"

  • "present" ← (默认)

  • "absent"

token

string

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

url

string

Jenkins 服务器的 URL。

默认: "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

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

已返回: 成功

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

user

string

用于身份验证的用户。

已返回: 成功

示例: "jenkins"

作者

  • Connor Newton (@phyrwork)