Spec-Zone.ru › Ansible 2.11

Разбор полуструктурированного текста с Ansible

Модуль cli_parse парсит полуструктурированные данные, такие как конфигурации сети, в структурированные данные, чтобы позволить программированное использование данных с этого устройства. Вы можете извлечь информацию с сетевого устройства и обновить CMDB в одном плане. Примеры использования включают автоматизированную диагностику, создание динамической документации, обновление инструментов IPAM (управление IP-адресами) и т. д.

  • Понимание парсера командной строки

    • Зачем парсить текст?
    • Когда не нужно парсить текст
  • Разбор командной строки

    • Разбор с помощью встроенного механизма парсинга

      • Пример сети
      • Пример Linux
    • Разбор JSON
    • Разбор с использованием шаблонов ntc_templates
    • Разбор с помощью pyATS
    • Разбор с помощью textfsm
    • Разбор с помощью TTP
    • Преобразование XML
  • Расширенные варианты использования

    • Указать полный путь к шаблону
    • Предоставить парсеру команду, отличную от выполняемой
    • Предоставить пользовательское значение ОС
    • Обработать существующий текст

Понимание парсера командной строки

Коллекция ansible.netcommon версии 1.2.0 или выше включает модуль cli_parse, который может выполнять команды CLI и анализировать полуструктурированный текстовый вывод. Вы можете использовать модуль cli_parse на устройстве, хосте или платформе, которые поддерживают только командную строку, а возвращаемые команды возвращают полуструктурированный текст. Модуль cli_parse может либо выполнить команду CLI на устройстве и вернуть обработанный результат, либо просто обработать любой текстовый документ. Модуль cli_parse включает плагины cli_parser для взаимодействия с различными движками парсинга.

Зачем парсить текст?

Парсинг полуструктурированных данных, таких как сетевые конфигурации, в структурированные данные позволяет программно использовать данные с этого устройства. Примеры использования включают автоматизированную диагностику, создание динамической документации, обновление инструментов IPAM (управление IP-адресами) и т. д. Вы можете предпочесть сделать это с Ansible напрямую, чтобы воспользоваться встроенными конструкциями Ansible, такими как:

  • Оператор when для условного выполнения других задач или ролей
  • Модуль assert для проверки соответствия конфигурации и операционного состояния
  • Модуль template для генерации отчетов о конфигурации и операционном состоянии
  • Шаблоны и модули command или config для генерации команд или конфигурации хостов, устройств или платформ
  • Модули текущей платформы facts для дополнения информации из встроенных фактов

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

Когда не нужно парсить текст

Не следует парсить полуструктурированный текст, когда:

  • Устройство, хост или платформа имеют RESTAPI и возвращают JSON.
  • Существующие модули фактов Ansible уже возвращают необходимые данные.
  • Существуют модули сетевых ресурсов Ansible для управления конфигурацией устройства и ресурса.

Разбор командной строки

Модуль cli_parse включает следующие плагины cli_parsing:

native

Встроенный в Ansible механизм парсинга, не требующий дополнительных библиотек Python

xml

Преобразование XML в собственные структуры данных Ansible

textfsm

Модуль Python, реализующий основанную на шаблонах автоматизированную машину состояний для разбора полуформатированного текста

ntc_templates

Набор предварительно определенных textfsm шаблонов, поддерживающих различные платформы и команды

ttp

Библиотека для разбора полуструктурированного текста с использованием шаблонов, дополненная возможностями для упрощения процесса

pyats

Использует парсеры, включенные в Cisco Test Automation & Validation Solution

json

Преобразование JSON-вывода командной строки в собственную структуру данных Ansible

Хотя Ansible содержит ряд плагинов, которые могут преобразовать XML в собственную структуру данных Ansible, модуль cli_parse выполняет команду на устройствах, возвращающих XML, и возвращает преобразованные данные в одной задаче.

Так как cli_parse использует основанную на плагинах архитектуру, он может использовать дополнительные движки парсинга из любой коллекции Ansible.

Примечание

Движки парсинга ansible.netcommon.native и ansible.netcommon.json полностью поддерживаются подпиской Red Hat Ansible Automation Platform. Поддержка подписки Red Hat Ansible Automation Platform ограничена использованием ntc_templates, pyATS, textfsm, xmltodict, общедоступных API, как задокументировано.

Разбор с помощью встроенного механизма парсинга

Встроенный механизм парсинга включен в модуль cli_parse. Он использует данные, полученные с помощью регулярных выражений, для заполнения структуры обработанных данных. Встроенный механизм парсинга требует файла шаблона YAML для обработки вывода команды.

Пример сети

В этом примере используется вывод команды сетевого устройства и применяется встроенный шаблон для получения вывода в структурированном формате Ansible.

Вывод команды show interface с сетевого устройства выглядит следующим образом:

Ethernet1/1 is up
admin state is up, Dedicated Interface
  Hardware: 100/1000/10000 Ethernet, address: 5254.005a.f8bd (bia 5254.005a.f8bd)
  MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec
  reliability 255/255, txload 1/255, rxload 1/255
  Encapsulation ARPA, medium is broadcast
  Port mode is access
  full-duplex, auto-speed
  Beacon is turned off
  Auto-Negotiation is turned on  FEC mode is Auto
  Input flow-control is off, output flow-control is off
  Auto-mdix is turned off
  Switchport monitor is off
  EtherType is 0x8100
  EEE (efficient-ethernet) : n/a
  Last link flapped 4week(s) 6day(s)
  Last clearing of "show interface" counters never
<...>

Создайте встроенный шаблон для соответствия этому выводу и сохраните его как templates/nxos_show_interface.yaml:

---
- example: Ethernet1/1 is up
  getval: '(?P<name>\S+) is (?P<oper_state>\S+)'
  result:
    "{{ name }}":
      name: "{{ name }}"
      state:
        operating: "{{ oper_state }}"
  shared: true

- example: admin state is up, Dedicated Interface
  getval: 'admin state is (?P<admin_state>\S+),'
  result:
    "{{ name }}":
      name: "{{ name }}"
      state:
        admin: "{{ admin_state }}"

- example: "  Hardware: Ethernet, address: 5254.005a.f8b5 (bia 5254.005a.f8b5)"
  getval: '\s+Hardware: (?P<hardware>.*), address: (?P<mac>\S+)'
  result:
    "{{ name }}":
      hardware: "{{ hardware }}"
      mac_address: "{{ mac }}"

Этот шаблон встроенного парсера структурирован как список парсеров, каждый из которых содержит следующие пары ключ-значение:

  • example - Пример строки текста, который нужно обработать
  • getval - Регулярное выражение с именованными группами захвата для хранения извлечённых данных
  • result - Дерево данных, заполненное как шаблон из обработанных данных
  • shared - (необязательно) Общий ключ делает обработанные значения доступными для остальных записей парсера до тех пор, пока не будет найдено соответствие.

Следующая задача использует cli_parse с встроенным парсером и приведенным выше шаблоном для обработки команды show interface с устройства Cisco NXOS:

- name: "Run command and parse with native"
  ansible.netcommon.cli_parse:
    command: show interface
      parser:
        name: ansible.netcommon.native
    set_fact: interfaces

Более глубокий анализ этой задачи:

  • Параметр command задаёт команду, которую нужно выполнить на устройстве или хосте. В качестве альтернативы можно предоставить текст из предыдущей команды с помощью параметра text.
  • Параметр parser предоставляет информацию, специфичную для движка парсинга.
  • Подпараметр name предоставляет полное имя коллекции (FQCN) движка парсинга (ansible.netcommon.native).
  • Модуль cli_parse, по умолчанию, ищет шаблон в каталоге шаблонов как {{ short_os }}_{{ command }}.yaml.

    • short_os в имени файла шаблона выводится из ansible_network_os, или ansible_distribution, хоста.
    • Пробелы в сетевой или командной строке хоста заменяются на _ в части имени файла шаблона command В этом примере сетевая команда show interfaces становится show_interfaces в имени файла.

Примечание

Встроенный движок парсинга ansible.netcommon.native полностью поддерживается с подпиской Red Hat Ansible Automation Platform.

В заключение этой задачи параметр set_fact устанавливает следующий факт interfaces для устройства на основе структурированных данных, возвращённых cli_parse:

Ethernet1/1:
    hardware: 100/1000/10000 Ethernet
    mac_address: 5254.005a.f8bd
    name: Ethernet1/1
    state:
    admin: up
    operating: up
Ethernet1/10:
    hardware: 100/1000/10000 Ethernet
    mac_address: 5254.005a.f8c6
<...>

Пример Linux

Вы также можете использовать встроенный парсер для выполнения команд и обработки вывода с хостов Linux.

Вывод образцовой команды Linux (ip addr show) выглядит следующим образом:

1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
    link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
    inet 127.0.0.1/8 scope host lo
       valid_lft forever preferred_lft forever
    inet6 ::1/128 scope host
       valid_lft forever preferred_lft forever
2: enp0s31f6: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc fq_codel state DOWN group default qlen 1000
    link/ether x2:6a:64:9d:84:19 brd ff:ff:ff:ff:ff:ff
3: wlp2s0: <BROADCAST,MULTICAST> mtu 1500 qdisc noop state DOWN group default qlen 1000
    link/ether x6:c2:44:f7:41:e0 brd ff:ff:ff:ff:ff:ff permaddr d8:f2:ca:99:5c:82

Создайте встроенный шаблон для соответствия этому выводу и сохраните его как templates/fedora_ip_addr_show.yaml:

---
- example: '1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000'
  getval: |
    (?x)                                                # free-spacing
    \d+:\s                                              # the interface index
    (?P<name>\S+):\s                                    # the name
    <(?P<properties>\S+)>                               # the properties
    \smtu\s(?P<mtu>\d+)                                 # the mtu
    .*                                                  # gunk
    state\s(?P<state>\S+)                               # the state of the interface
  result:
    "{{ name }}":
        name: "{{ name }}"
        loopback: "{{ 'LOOPBACK' in stats.split(',') }}"
        up: "{{ 'UP' in properties.split(',')  }}"
        carrier: "{{ not 'NO-CARRIER' in properties.split(',') }}"
        broadcast: "{{ 'BROADCAST' in properties.split(',') }}"
        multicast: "{{ 'MULTICAST' in properties.split(',') }}"
        state: "{{ state|lower() }}"
        mtu: "{{ mtu }}"
  shared: True

- example: 'inet 192.168.122.1/24 brd 192.168.122.255 scope global virbr0'
  getval: |
   (?x)                                                 # free-spacing
   \s+inet\s(?P<inet>([0-9]{1,3}\.){3}[0-9]{1,3})       # the ip address
   /(?P<bits>\d{1,2})                                   # the mask bits
  result:
    "{{ name }}":
        ip_address: "{{ inet }}"
        mask_bits: "{{ bits }}"

Примечание

Ключ shared в шаблоне парсера позволяет использовать имя интерфейса в последующих записях парсера. Использование примеров и режима свободного форматирования с регулярными выражениями делает шаблон более читаемым.

Следующая задача использует cli_parse с встроенным парсером и приведенным выше шаблоном для обработки вывода Linux:

- name: Run command and parse
  ansible.netcommon.cli_parse:
    command: ip addr show
    parser:
      name: ansible.netcommon.native
    set_fact: interfaces

Эта задача предполагает, что вы предварительно собрали факты, чтобы определить ansible_distribution для поиска шаблона. В качестве альтернативы, вы можете указать путь в параметре parser/template_path.

В заключение этой задачи, параметр set_fact устанавливает следующий факт interfaces для хоста на основе структурированных данных, возвращённых cli_parse:

lo:
  broadcast: false
  carrier: true
  ip_address: 127.0.0.1
  mask_bits: 8
  mtu: 65536
  multicast: false
  name: lo
  state: unknown
  up: true
enp64s0u1:
  broadcast: true
  carrier: true
  ip_address: 192.168.86.83
  mask_bits: 24
  mtu: 1500
  multicast: true
  name: enp64s0u1
  state: up
  up: true
<...>

Разбор JSON

Хотя Ansible будет автоматически преобразовывать сериализованный JSON в собственные структуры данных при распознавании, вы также можете использовать модуль cli_parse для этого преобразования.

Пример задачи:

- name: "Run command and parse as json"
  ansible.netcommon.cli_parse:
    command: show interface | json
    parser:
      name: ansible.netcommon.json
    register: interfaces

Более глубокий анализ этой задачи:

  • Команда show interface | json выполняется на устройстве.
  • Вывод устанавливается как факт interfaces для устройства.
  • Поддержка JSON предоставляется в основном для согласованности выполнения задач.

Примечание

Использование ansible.netcommon.json полностью поддерживается с подпиской на Red Hat Ansible Automation Platform

Разбор с использованием шаблонов ntc_templates

Библиотека ntc_templates python содержит предварительно определённые textfsm шаблоны для разбора вывода различных команд устройств сети.

Пример задачи:

- name: "Run command and parse with ntc_templates"
  ansible.netcommon.cli_parse:
    command: show interface
    parser:
      name: ansible.netcommon.ntc_templates
    set_fact: interfaces

Более глубокий анализ этой задачи:

  • ansible_network_os устройства преобразуется в формат ntc_template cisco_nxos. В качестве альтернативы можно указать os с опцией parser/os.
  • Шаблон cisco_nxos_show_interface.textfsm, включенный в пакет ntc_templates, анализирует вывод.
  • Дополнительную информацию о библиотеке ntc_templates python см. в файле README ntc_templates.

Примечание

Поддержка подписки Red Hat Ansible Automation Platform ограничена использованием общедоступных API ntc_templates в соответствии с документацией.

Эта задача устанавливает следующий факт в качестве факта interfaces для хоста:

interfaces:
- address: 5254.005a.f8b5
  admin_state: up
  bandwidth: 1000000 Kbit
  bia: 5254.005a.f8b5
  delay: 10 usec
  description: ''
  duplex: full-duplex
  encapsulation: ARPA
  hardware_type: Ethernet
  input_errors: ''
  input_packets: ''
  interface: mgmt0
  ip_address: 192.168.101.14/24
  last_link_flapped: ''
  link_status: up
  mode: ''
  mtu: '1500'
  output_errors: ''
  output_packets: ''
  speed: 1000 Mb/s
- address: 5254.005a.f8bd
  admin_state: up
  bandwidth: 1000000 Kbit
  bia: 5254.005a.f8bd
  delay: 10 usec

Разбор с использованием pyATS

pyATS является частью решения Cisco Test Automation & Validation. Оно включает в себя множество предварительно определённых парсеров для ряда сетевых платформ и команд. Предварительно определённые парсеры, входящие в пакет pyATS, можно использовать с модулем cli_parse.

Пример задачи:

- name: "Run command and parse with pyats"
  ansible.netcommon.cli_parse:
    command: show interface
    parser:
      name: ansible.netcommon.pyats
    set_fact: interfaces

Более глубокий анализ этой задачи:

  • Модули cli_parse автоматически преобразуют ansible_network_os (в этом примере ansible_network_os установлено в cisco.nxos.nxos, преобразуется в nxos для pyATS. В качестве альтернативы можно указать ОС с опцией parser/os).
  • Используя комбинацию команды и ОС, pyATS выбирает следующий парсер: https://pubhub.devnetcloud.com/media/genie-feature-browser/docs/#/parsers/show%2520interface.
  • Модуль cli_parse устанавливает cisco.ios.ios в iosxe для pyATS. Это значение можно переопределить с помощью опции parser/os.
  • cli_parse использует только предварительно определённые парсеры в pyATS. Дополнительную информацию см. в документации pyATS и полном списке включённых парсеров pyATS.

Примечание

Поддержка подписки Red Hat Ansible Automation Platform ограничена использованием общедоступных API pyATS в соответствии с документацией.

Эта задача устанавливает следующий факт в качестве факта interfaces для хоста:

mgmt0:
  admin_state: up
  auto_mdix: 'off'
  auto_negotiate: true
  bandwidth: 1000000
  counters:
    in_broadcast_pkts: 3
    in_multicast_pkts: 1652395
    in_octets: 556155103
    in_pkts: 2236713
    in_unicast_pkts: 584259
    rate:
      in_rate: 320
      in_rate_pkts: 0
      load_interval: 1
      out_rate: 48
      out_rate_pkts: 0
    rx: true
    tx: true
  delay: 10
  duplex_mode: full
  enabled: true
  encapsulations:
    encapsulation: arpa
  ethertype: '0x0000'
  ipv4:
    192.168.101.14/24:
      ip: 192.168.101.14
      prefix_length: '24'
  link_state: up
  <...>

Разбор с использованием textfsm

textfsm — это модуль Python, реализующий шаблонно-ориентированную машину состояний для разбора полуформатированного текста.

Следующий пример шаблона ``textfsm`` хранится в templates/nxos_show_interface.textfsm

Value Required INTERFACE (\S+)
Value LINK_STATUS (.+?)
Value ADMIN_STATE (.+?)
Value HARDWARE_TYPE (.\*)
Value ADDRESS ([a-zA-Z0-9]+.[a-zA-Z0-9]+.[a-zA-Z0-9]+)
Value BIA ([a-zA-Z0-9]+.[a-zA-Z0-9]+.[a-zA-Z0-9]+)
Value DESCRIPTION (.\*)
Value IP_ADDRESS (\d+\.\d+\.\d+\.\d+\/\d+)
Value MTU (\d+)
Value MODE (\S+)
Value DUPLEX (.+duplex?)
Value SPEED (.+?)
Value INPUT_PACKETS (\d+)
Value OUTPUT_PACKETS (\d+)
Value INPUT_ERRORS (\d+)
Value OUTPUT_ERRORS (\d+)
Value BANDWIDTH (\d+\s+\w+)
Value DELAY (\d+\s+\w+)
Value ENCAPSULATION (\w+)
Value LAST_LINK_FLAPPED (.+?)

Start
  ^\S+\s+is.+ -> Continue.Record
  ^${INTERFACE}\s+is\s+${LINK_STATUS},\sline\sprotocol\sis\s${ADMIN_STATE}$$
  ^${INTERFACE}\s+is\s+${LINK_STATUS}$$
  ^admin\s+state\s+is\s+${ADMIN_STATE},
  ^\s+Hardware(:|\s+is)\s+${HARDWARE_TYPE},\s+address(:|\s+is)\s+${ADDRESS}(.*bia\s+${BIA})*
  ^\s+Description:\s+${DESCRIPTION}
  ^\s+Internet\s+Address\s+is\s+${IP_ADDRESS}
  ^\s+Port\s+mode\s+is\s+${MODE}
  ^\s+${DUPLEX}, ${SPEED}(,|$$)
  ^\s+MTU\s+${MTU}.\*BW\s+${BANDWIDTH}.\*DLY\s+${DELAY}
  ^\s+Encapsulation\s+${ENCAPSULATION}
  ^\s+${INPUT_PACKETS}\s+input\s+packets\s+\d+\s+bytes\s\*$$
  ^\s+${INPUT_ERRORS}\s+input\s+error\s+\d+\s+short\s+frame\s+\d+\s+overrun\s+\d+\s+underrun\s+\d+\s+ignored\s\*$$
  ^\s+${OUTPUT_PACKETS}\s+output\s+packets\s+\d+\s+bytes\s\*$$
  ^\s+${OUTPUT_ERRORS}\s+output\s+error\s+\d+\s+collision\s+\d+\s+deferred\s+\d+\s+late\s+collision\s\*$$
  ^\s+Last\s+link\s+flapped\s+${LAST_LINK_FLAPPED}\s\*$$

Следующая задача использует пример шаблона для textfsm с модулем cli_parse.

- name: "Run command and parse with textfsm"
  ansible.netcommon.cli_parse:
    command: show interface
    parser:
      name: ansible.netcommon.textfsm
    set_fact: interfaces

Более глубокий анализ этой задачи:

  • ansible_network_os устройства (cisco.nxos.nxos) преобразуется в nxos. В качестве альтернативы можно указать ОС в опции parser/os.
  • Имя шаблона textfsm по умолчанию установлено как templates/nxos_show_interface.textfsm с использованием комбинации ОС и выполняемой команды. В качестве альтернативы можно переопределить путь к сгенерированному шаблону с помощью опции parser/template_path.
  • Подробную информацию см. в файле README textfsm.
  • textfsm ранее предоставлялся в качестве плагина фильтрации. Пользователи Ansible должны перейти к модулю cli_parse.

Примечание

Поддержка подписки Red Hat Ansible Automation Platform ограничена использованием общедоступных API textfsm в соответствии с документацией.

Эта задача устанавливает следующий факт как факт interfaces для хоста:

- ADDRESS: X254.005a.f8b5
  ADMIN_STATE: up
  BANDWIDTH: 1000000 Kbit
  BIA: X254.005a.f8b5
  DELAY: 10 usec
  DESCRIPTION: ''
  DUPLEX: full-duplex
  ENCAPSULATION: ARPA
  HARDWARE_TYPE: Ethernet
  INPUT_ERRORS: ''
  INPUT_PACKETS: ''
  INTERFACE: mgmt0
  IP_ADDRESS: 192.168.101.14/24
  LAST_LINK_FLAPPED: ''
  LINK_STATUS: up
  MODE: ''
  MTU: '1500'
  OUTPUT_ERRORS: ''
  OUTPUT_PACKETS: ''
  SPEED: 1000 Mb/s
- ADDRESS: X254.005a.f8bd
  ADMIN_STATE: up
  BANDWIDTH: 1000000 Kbit
  BIA: X254.005a.f8bd

Разбор с использованием TTP

TTP — это библиотека Python для разбора полуструктурированного текста с помощью шаблонов. TTP использует синтаксис, похожий на jinja, чтобы минимизировать необходимость в регулярных выражениях. Пользователи, знакомые с шаблонизацией jinja, могут найти синтаксис шаблонов TTP знакомым.

Следующий пример шаблона TTP сохранен как templates/nxos_show_interface.ttp:

{{ interface }} is {{ state }}
admin state is {{ admin_state }}{{ ignore(".\*") }}

Следующая задача использует этот шаблон для разбора вывода команды show interface:

- name: "Run command and parse with ttp"
  ansible.netcommon.cli_parse:
    command: show interface
    parser:
      name: ansible.netcommon.ttp
    set_fact: interfaces

Более глубокий анализ этой задачи:

  • Путь к шаблону по умолчанию templates/nxos_show_interface.ttp был сгенерирован с использованием ansible_network_os хоста и command.
  • TTP поддерживает несколько дополнительных переменных, которые будут переданы парсеру. Они включают:

    • parser/vars/ttp_init — дополнительный параметр, передаваемый при инициализации парсера.
    • parser/vars/ttp_results — дополнительные параметры, влияющие на вывод парсера.
    • parser/vars/ttp_vars — дополнительные переменные, доступные в шаблоне.
  • Подробную информацию см. в документации TTP.

Задача устанавливает следующий факт как факт interfaces для хоста:

- admin_state: up,
  interface: mgmt0
  state: up
- admin_state: up,
  interface: Ethernet1/1
  state: up
- admin_state: up,
  interface: Ethernet1/2
  state: up

Преобразование XML

Хотя Ansible содержит ряд плагинов, которые могут преобразовывать XML в собственные структуры данных Ansible, модуль cli_parse выполняет команду на устройствах, возвращающих XML, и возвращает преобразованные данные в одной задаче.

Эта примерная задача выполняет команду show interface и анализирует вывод как XML:

- name: "Run command and parse as xml"
    ansible.netcommon.cli_parse:
      command: show interface | xml
      parser:
        name: ansible.netcommon.xml
  set_fact: interfaces

Примечание

Поддержка подписки Red Hat Ansible Automation Platform ограничена использованием общедоступных API xmltodict в соответствии с документацией.

Эта задача устанавливает факт interfaces для хоста на основе этого возвращаемого вывода:

nf:rpc-reply:
  '@xmlns': http://www.cisco.com/nxos:1.0:if_manager
  '@xmlns:nf': urn:ietf:params:xml:ns:netconf:base:1.0
  nf:data:
    show:
      interface:
        __XML__OPT_Cmd_show_interface_quick:
          __XML__OPT_Cmd_show_interface___readonly__:
            __readonly__:
              TABLE_interface:
                ROW_interface:
                - admin_state: up
                  encapsulation: ARPA
                  eth_autoneg: 'on'
                  eth_bia_addr: x254.005a.f8b5
                  eth_bw: '1000000'

Расширенные варианты использования

Модуль cli_parse поддерживает несколько функций для поддержки более сложных вариантов использования.

Указать полный путь к шаблону

Используйте опцию template_path для переопределения пути к шаблону по умолчанию в задаче:

- name: "Run command and parse with native"
  ansible.netcommon.cli_parse:
    command: show interface
    parser:
      name: ansible.netcommon.native
      template_path: /home/user/templates/filename.yaml

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

Используйте подопцию command для parser для настройки команды, ожидаемой парсером, если она отличается от команды, которую выполняет cli_parse:

- name: "Run command and parse with native"
  ansible.netcommon.cli_parse:
    command: sho int
    parser:
      name: ansible.netcommon.native
      command: show interface

Указать пользовательское значение ОС

Используйте подопцию os для парсера, чтобы напрямую установить ОС вместо использования ansible_network_os или ansible_distribution для генерации пути к шаблону или с указанным движком парсера:

- name: Use ios instead of iosxe for pyats
  ansible.netcommon.cli_parse:
    command: show something
    parser:
      name: ansible.netcommon.pyats
      os: ios

- name: Use linux instead of fedora from ansible_distribution
  ansible.netcommon.cli_parse:
    command: ps -ef
    parser:
      name: ansible.netcommon.native
      os: linux

Анализировать существующий текст

Используйте опцию text вместо command для анализа текста, собранного ранее в выполнении задач:

# using /home/user/templates/filename.yaml
- name: "Parse text from previous task"
  ansible.netcommon.cli_parse:
    text: "{{ output['stdout'] }}"
    parser:
      name: ansible.netcommon.native
      template_path: /home/user/templates/filename.yaml

 # using /home/user/templates/filename.yaml
- name: "Parse text from file"
  ansible.netcommon.cli_parse:
    text: "{{ lookup('file', 'path/to/file.txt') }}"
    parser:
      name: ansible.netcommon.native
      template_path: /home/user/templates/filename.yaml

# using templates/nxos_show_version.yaml
- name: "Parse text from previous task"
  ansible.netcommon.cli_parse:
    text: "{{ sho_version['stdout'] }}"
    parser:
      name: ansible.netcommon.native
      os: nxos
      command: show version

См. также

  • Разработка плагинов cli_parser в коллекции

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/network/user_guide/cli_parsing.html

Spec-Zone.ru

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