Spec-Zone.ru › Ansible

Инвентаризация community.general.nmap — использует nmap для поиска целевых узлов

Примечание

Этот плагин инвентаризации входит в коллекцию community.general (версия 12.6.1).

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

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

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры

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

  • Использует файл конфигурации YAML с допустимым расширением YAML.

Требования

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

  • Установленный интерфейс командной строки nmap

Параметры

Параметр

Комментарии

address

строка / обязательный

IP-адрес сети или диапазон IP-адресов для сканирования. Можно использовать простой диапазон (10.2.2.15-25) или нотацию CIDR.

Конфигурация:

  • Переменная окружения: ANSIBLE_NMAP_ADDRESS

    добавлено в community.general 6.6.0

cache

логическое значение

Включить или отключить кеширование исходных данных инвентаризации. Для работы требуется настроить плагин кеширования.

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Запись INI:

    [inventory]
cache = false
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE

cache_connection

строка

Данные подключения к кешу или путь к нему; подробности см. в документации плагина кеширования.

Конфигурация:

  • Записи INI:

    [defaults]
fact_caching_connection = VALUE

    [inventory]
cache_connection = VALUE
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_CONNECTION
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

строка

Плагин кеширования, используемый для исходных данных инвентаризации.

По умолчанию: "memory"

Конфигурация:

  • Записи INI:

    [defaults]
fact_caching = memory

    [inventory]
cache_plugin = memory
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

строка

Префикс для файлов или таблиц плагина кеширования.

По умолчанию: "ansible_inventory_"

Конфигурация:

  • Записи INI:

    [defaults]
fact_caching_prefix = ansible_inventory_

    [inventory]
cache_prefix = ansible_inventory_
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_PREFIX
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

целое число

Длительность кеширования в секундах.

По умолчанию: 3600

Конфигурация:

  • Записи INI:

    [defaults]
fact_caching_timeout = 3600

    [inventory]
cache_timeout = 3600
  • Переменная окружения: ANSIBLE_CACHE_PLUGIN_TIMEOUT
  • Переменная окружения: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

словарь

Создание переменных на основе выражений Jinja2.

По умолчанию: {}

dns_resolve

логическое значение

добавлено в community.general 6.1.0

Всегда (true) или никогда (false) выполнять разрешение DNS-имен.

Варианты:

  • false ← (по умолчанию)
  • true

dns_servers

список / элементы=строка

добавлено в community.general 10.5.0

Указать DNS-серверы, используемые для разрешения имён.

exclude

список / элементы=строка

Список адресов, которые нужно исключить.

Например, 10.2.2.15-25 или 10.2.2.15,10.2.2.16.

Конфигурация:

  • Переменная окружения: ANSIBLE_NMAP_EXCLUDE

    добавлено в community.general 6.6.0

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

Значение по умолчанию, используемое, если значение переменной узла равно None или представляет собой пустую строку.

Этот параметр несовместим с keyed_groups[].trailing_separator.

key

строка

Ключ входного словаря, используемый для создания групп.

parent_group

строка

Родительская группа для группы, созданной по ключу.

prefix

строка

Имя группы, созданной по ключу, будет начинаться с этого префикса.

По умолчанию: ""

separator

строка

Разделитель, используемый для формирования имени группы, созданной по ключу.

По умолчанию: "_"

trailing_separator

логическое значение

добавлено в ansible-core 2.12

Установите для этого параметра значение false, чтобы не добавлять keyed_groups[].separator после переменной узла, если её значение равно None или представляет собой пустую строку.

Этот параметр несовместим с 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

строка / обязательный

Маркер, подтверждающий, что этот файл является источником для плагина community.general.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, чтобы проверить порт 53 по UDP, порты 21–25 по TCP, порт 9 по SCTP и порты 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

Всегда использовать быстрый ARP ping (true) или использовать более медленный, но надёжный метод (false).

Варианты:

  • false
  • true ← (по умолчанию)

use_extra_vars

логическое значение

добавлено в ansible-core 2.11

Объединить дополнительные переменные с доступными переменными для композиции (наивысший приоритет).

Варианты:

  • false ← (по умолчанию)
  • true

Конфигурация:

  • Запись INI:

    [inventory_plugins]
use_extra_vars = false
  • Переменная окружения: ANSIBLE_INVENTORY_USE_EXTRA_VARS

Примечание

Записи конфигурации, перечисленные выше для каждого типа параметров (переменная Ansible, переменная окружения и т. д.), упорядочены от низкого приоритета к высокому. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету — от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

  • Как минимум один из параметров ipv4 или ipv6 должен иметь значение true; оба параметра могут иметь значение true, но не могут оба иметь значение false.
  • TODO: добавить определение ОС.
  • На этом этапе инвентаризация ещё не завершена, поэтому автоматически заполненные группы all и ungrouped будут содержать только те данные, которые предыдущие источники инвентаризации добавили в них явно.
  • Во время построения инвентаризации динамические «магические переменные» времени выполнения недоступны. Например, groups и hostvars ещё не существуют.

Примеры

---
# 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')"

Авторы

  • Неизвестно

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос
  • Сообщить об ошибке
  • Предложить функцию
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API