community.general.nmap 清单 – 使用 nmap 查找目标主机

注意

此清单插件是 community.general 集合（版本 10.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此清单插件，请参阅 要求 了解详细信息。

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

概要

  • 使用带有有效 YAML 扩展名的 YAML 配置文件。

要求

本地控制器节点上需要以下要求才能执行此清单。

  • 安装了 nmap CLI

参数

参数

注释

地址

字符串 / 必需

要扫描的网络 IP 或 IP 范围，您可以使用简单范围 (10.2.2.15-25) 或 CIDR 表示法。

配置

缓存

布尔值

切换以启用/禁用清单源数据的缓存，需要设置缓存插件才能工作。

选项

  • false ← （默认）

  • true

配置

cache_connection

字符串

缓存连接数据或路径，请阅读缓存插件文档以了解具体信息。

配置

cache_plugin

字符串

用于清单源数据的缓存插件。

默认值： "memory"

配置

cache_prefix

字符串

用于缓存插件文件/表的前缀

默认值： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（以秒为单位）

默认值： 3600

配置

compose

字典

从 jinja2 表达式创建变量。

默认值： {}

dns_resolve

布尔值

在 community.general 6.1.0 中添加

是否始终 (true) 或从不 (false) 进行 DNS 解析。

选项

  • false ← （默认）

  • true

排除

列表 / 元素=字符串

要排除的地址列表。

例如 10.2.2.15-25 或 10.2.2.15,10.2.2.16。

配置

groups

字典

基于 Jinja2 条件将主机添加到组。

默认值： {}

icmp_timestamp

布尔值

在 community.general 6.1.0 中添加

通过 ICMP 时间戳进行扫描 (-PP)。

根据你的系统，你可能需要 sudo=true 才能使其工作。

选项

  • false ← （默认）

  • true

ipv4

布尔值

使用 IPv4 类型地址

选项

  • false

  • true ← (默认)

ipv6

布尔值

使用 IPv6 类型地址

选项

  • false

  • true ← (默认)

keyed_groups

列表 / 元素=字典

基于变量的值将主机添加到组。

默认值: []

default_value

字符串

在 ansible-core 2.12 中添加

当主机变量的值为空字符串时的默认值。

此选项与 keyed_groups[].trailing_separator 互斥。

key

字符串

用于生成组的输入字典中的键

parent_group

字符串

键控组的父组

prefix

字符串

键控组名称将以此前缀开头

默认值: ""

separator

字符串

用于构建键控组名称的分隔符

默认值: "_"

trailing_separator

布尔值

在 ansible-core 2.12 中添加

将此选项设置为 False 以省略当值为空字符串时主机变量之后的 keyed_groups[].separator。

此选项与 keyed_groups[].default_value 互斥。

选项

  • false

  • true ← (默认)

leading_separator

布尔值

在 ansible-core 2.11 中添加

与 keyed_groups 结合使用。

默认情况下，没有提供前缀或分隔符的键控组的名称将以下划线开头。

这是因为默认前缀为 ""，默认分隔符为 "_"。

如果未给定前缀，请将此选项设置为 False 以省略前导下划线（或其他分隔符）。

如果组名称是从映射派生的，则分隔符仍然用于连接项目。

为了完全不在组名称中使用分隔符，请将键控组的分隔符设置为空字符串。

选项

  • false

  • true ← (默认)

open

布尔值

在 community.general 6.5.0 中添加

仅扫描打开（或可能打开）的端口。

选项

  • false ← （默认）

  • true

plugin

字符串 / 必需

确保这是“nmap”插件的源文件的令牌。

选项

  • "nmap"

  • "community.general.nmap"

port

字符串

在 community.general 6.5.0 中添加

仅扫描特定端口或端口范围 (-p)。

例如，你可以传递 22 作为单个端口，1-65535 作为端口范围，或 U:53,137,T:21-25,139,8080,S:9 以使用 UDP 检查端口 53，使用 TCP 检查端口 21-25，使用 SCTP 检查端口 9，并使用所有协议检查端口 137、139 和 8080。

ports

布尔值

启用/禁用端口扫描。

选项

  • false

  • true ← (默认)

strict

布尔值

如果 yes，则将无效条目作为致命错误，否则跳过并继续。

由于可以在表达式中使用事实，因此它们可能并非总是可用，并且默认情况下我们会忽略这些错误。

选项

  • false ← （默认）

  • true

sudo

布尔值

在 community.general 4.8.0 中添加

设置为 true 以执行 sudo nmap 插件扫描。

选项

  • false ← （默认）

  • true

udp_scan

布尔值

在 community.general 6.1.0 中添加

通过 UDP 进行扫描。

根据你的系统，你可能需要 sudo=true 才能使其工作。

选项

  • false ← （默认）

  • true

use_arp_ping

布尔值

在 community.general 7.4.0 中添加

是否始终 (true) 使用快速 ARP ping 或 (false) 较慢但更可靠的方法。

选项

  • false

  • true ← (默认)

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

将额外的变量合并到可用于组合的变量中（优先级最高）。

选项

  • false ← （默认）

  • true

配置

注意事项

注意

  • 至少需要将 ipv4 或 ipv6 中的一个设置为 true；两者都可以为 true，但不能都为 false。

  • TODO：添加操作系统指纹识别

示例

# inventory.config file in YAML format
plugin: community.general.nmap
strict: false
address: 192.168.0.0/24


# a sudo nmap scan to fully use nmap scan power.
plugin: community.general.nmap
sudo: true
strict: false
address: 192.168.0.0/24

# an nmap scan specifying ports and classifying results to an inventory group
plugin: community.general.nmap
address: 192.168.0.0/24
exclude: 192.168.0.1, web.example.com
port: 22, 443
groups:
  web_servers: "ports | selectattr('port', 'equalto', '443')"

作者

  • 未知

提示

每个条目类型的配置条目都具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖列表中较高的变量。