ansible.windows.win_service_info 模块 – 收集 Windows 服务信息

注意

此模块是 ansible.windows 集合（版本 2.5.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install ansible.windows。

要在 playbook 中使用它，请指定：ansible.windows.win_service_info。

概要

• 收集所有或特定已安装的 Windows 服务的信息。

参数

参数	注释
名称 字符串	如果指定，则使用它来匹配要获取信息的 Windows 服务的 name 或 display_name。 可以是通配符以匹配多个服务，但通配符只会匹配服务的 name，而不是 display_name。 如果省略，则将返回所有服务。

参见

另请参见

ansible.windows.win_service

管理和查询 Windows 服务。

示例

- name: Get info for all installed services
  ansible.windows.win_service_info:
  register: service_info

- name: Get info for a single service
  ansible.windows.win_service_info:
    name: WinRM
  register: service_info

- name: Get info for a service using its display name
  ansible.windows.win_service_info:
    name: Windows Remote Management (WS-Management)

- name: Find all services that start with 'win'
  ansible.windows.win_service_info:
    name: win*

返回值

通用返回值记录在 此处，以下是此模块特有的字段

键	描述
存在 布尔值	是否根据指定的条件找到任何服务。 返回：始终 示例： true
服务 列表 / 元素=字典	根据条件找到的服务列表。 如果未找到任何服务，则将为空列表。 返回：始终
检查点 整数	服务定期递增以报告其进度的检查点值。 返回：成功 示例： 0
接受的控件 列表 / 元素=字符串	服务可以接受的控件列表。 常见控件有 stop、pause_continue、shutdown。 返回：成功 示例： ["stop", "shutdown"]
依赖关系 列表 / 元素=字符串	此服务所依赖的服务的 name 列表。 返回：成功 示例： ["HTTP", "RPCSS"]
依赖于 列表 / 元素=字符串	依赖于此服务的服务的 name 列表。 返回：成功 示例： ["upnphost", "WMPNetworkSvc"]
描述 字符串	服务的描述。 返回：成功 示例： "Windows 服务的示例描述。"
桌面交互 布尔值	服务是否可以与桌面交互，仅对以 SYSTEM 身份运行的服务有效。 返回：成功 示例： false
显示名称 字符串	SCM 用于标识服务的显示名称。 返回：成功 示例： "Windows 远程管理 (WS-Management)"
错误控制 字符串	如果服务无法启动，则要采取的操作。 常见值为 critical、ignore、normal、severe。 返回：成功 示例： "normal"
非崩溃失败时的失败操作 布尔值	控制何时根据服务停止的方式触发失败操作。 返回：成功 示例： false
失败操作 列表 / 元素=字典	在发生故障时要运行的故障操作列表。 返回：成功
delay_ms 整数	执行指定操作之前等待的时间（以毫秒为单位）。 返回：成功 示例： 120000
类型 字符串	将要执行的操作。 常见值为 none、reboot、restart、run_command。 返回：成功 示例： "run_command"
失败命令 字符串	当触发 run_command 失败操作时将运行的命令行。 返回：成功 示例： "runme.exe"
失败重启消息 字符串	在触发 reboot 失败操作时，在重新启动之前要向服务器用户广播的消息。 返回：成功 示例： "服务失败，正在重新启动主机。"
失败重置周期（秒） 整数	将故障计数重置为零的时间（以秒为单位）。 返回：成功 示例： 86400
启动保护 字符串	服务的保护类型。 常见值为 none、windows、windows_light 或 antimalware_light。 返回：成功 示例： "none"
加载顺序组 字符串	服务所属的加载顺序组的名称。 如果服务不属于任何组，则为空字符串。 返回：成功 示例: "我的组"
名称 字符串	服务的名称。 返回：成功 示例: "WinRM"
路径 字符串	服务二进制文件的路径以及启动服务时使用的任何参数。 二进制文件部分可以用引号引起来，以确保路径中的任何空格都不会被视为参数。 返回：成功 示例: "C:\\Windows\\System32\\svchost.exe -k netsvcs -p"
pre_shutdown_timeout_ms 整数	预关闭超时值，以毫秒为单位。 返回：成功 示例: 10000
preferred_node 整数	首选节点的节点编号。 如果 Windows 主机没有 NUMA 配置，则此值为 null。 返回：成功 示例： 0
process_id 整数	正在运行的服务的进程标识符。 返回：成功 示例: 5135
required_privileges 列表 / 元素=字符串	服务需要并将在其中运行的权限列表 返回：成功 示例: ["SeBackupPrivilege", "SeRestorePrivilege"]
service_exit_code 整数	服务在启动或停止时设置的服务特定的错误代码。 返回：成功 示例： 0
service_flags 列表 / 元素=字符串	显示有关正在运行的服务的行为的更多信息。 目前唯一可以设置的标志是 runs_in_system_process。 返回：成功 示例: ["runs_in_system_process"]
service_type 字符串	服务的类型。 常见的类型有 win32_own_process, win32_share_process, user_own_process, user_share_process, kernel_driver。 返回：成功 示例: "win32_own_process"
sid_info 字符串	服务访问令牌的生成方式以及如何将服务 SID 添加到令牌的行为。 常见的值有 none、restricted 或 unrestricted。 返回：成功 示例： "none"
start_mode 字符串	设置服务何时启动。 常见的值有 auto、manual、disabled、delayed。 返回：成功 示例: "auto"
state 字符串	服务当前的运行状态。 常见的值有 stopped、start_pending、stop_pending、started、continue_pending、pause_pending、paused。 返回：成功 示例: "started"
triggers 列表 / 元素=字典	为服务定义的触发器列表。 返回：成功
action 字符串	触发后要执行的操作，可以是 start_service 或 stop_service。 返回：成功 示例: "start_service"
data_items 列表 / 元素=字典	包含触发器特定数据的触发器数据项列表。 一个触发器可以包含 0 个或多个数据项。 返回：成功
data complex	触发器数据项的值。 可以是字符串、字符串列表、整数或二进制数据的 base64 字符串。 返回：成功 示例: "命名管道"
类型 字符串	触发器的 data 类型。 常见的值有 string、binary、level、keyword_any 或 keyword_all。 返回：成功 示例: "string"
sub_type 字符串	特定于每个 type 的触发器事件子类型。 常见的值有 named_pipe_event、domain_join、domain_leave、firewall_port_open 等。 返回：成功
sub_type_guid 字符串	表示触发器子类型的 GUID。 返回：成功 示例: "1ce20aba-9851-4421-9430-1ddeb766e809"
类型 字符串	触发器事件类型。 常见的值有 custom、rpc_interface_event、domain_join、group_policy 等。 返回：成功 示例: "domain_join"
username 字符串	用于运行服务的用户名。 对于用户服务和某些驱动程序服务，可以为 null。 返回：成功 示例: "NT AUTHORITY\\SYSTEM"
wait_hint_ms 整数	挂起的启动、停止、暂停或继续操作所需的估计时间（以毫秒为单位）。 返回：成功 示例： 0
win32_exitcode 整数	服务二进制文件停止后返回的错误代码。 当设置为 1066 时，会在 service_exit_code 上返回特定于服务的错误。 返回：成功 示例： 0

作者

• Jordan Borean (@jborean93)

合集链接

• 问题跟踪器
• 存储库 (源代码)
• 沟通