community.general.jc filter – Преобразование вывода многих команд оболочки и типов файлов в JSON

Примечание

Этот плагин фильтра является частью коллекции community.general (версия 9.5.0).

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

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

Для использования в книге задач укажите: community.general.jc.

Новое в community.general 1.1.0

Обзор
Требования
Входные данные
Позиционные параметры
Параметры ключевых слов
Примечания
Примеры
Возвращаемое значение

Обзор

Преобразование вывода многих команд оболочки и типов файлов в JSON.
Использует библиотеку jc.

Требования

Ниже перечислены требования, необходимые на локальном узле контроллера, который выполняет этот фильтр.

jc, установленный как библиотека Python (https://pypi.org/project/jc/)

Входные данные

Это описание входных данных фильтра, значение перед | community.general.jc.

Параметр	Комментарии
Входные данные строка / обязательно	Данные для преобразования.

Позиционные параметры

Это описание позиционных параметров фильтра. Это значения positional1, positional2 и так далее в следующем примере: input | community.general.jc(positional1, positional2, ...)

Параметр	Комментарии
parser строка / обязательно	Правильный парсер для входных данных. Например, `ifconfig`. Примечание: используйте нижние подчеркивания вместо дефисов (если есть) в имени модуля парсера. Список последних парсеров см. в https://github.com/kellyjonbrazil/jc#parsers.

Параметры ключевых слов

Это описание параметров ключевых слов фильтра. Это значения key1=value1, key2=value2 и так далее в следующем примере: input | community.general.jc(key1=value1, key2=value2, ...)

Параметр	Комментарии
quiet булево	Установите значение `false` для подавления предупреждений. Варианты: `false` `true` ← (по умолчанию)
raw булево	Установите значение `true` для возврата предварительно обработанного JSON. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

При совместном использовании параметров ключевых слов и позиционных параметров позиционные параметры должны перечисляться до параметров ключевых слов: input | community.general.jc(positional1, positional2, key1=value1, key2=value2)

Примеры

- name: Install the prereqs of the jc filter (jc Python package) on the Ansible controller
  delegate_to: localhost
  ansible.builtin.pip:
    name: jc
    state: present

- name: Run command
  ansible.builtin.command: uname -a
  register: result

- name: Convert command's result to JSON
  ansible.builtin.debug:
    msg: "{{ result.stdout | community.general.jc('uname') }}"
  # Possible output:
  #
  # "msg": {
  #   "hardware_platform": "x86_64",
  #   "kernel_name": "Linux",
  #   "kernel_release": "4.15.0-112-generic",
  #   "kernel_version": "#113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020",
  #   "machine": "x86_64",
  #   "node_name": "kbrazil-ubuntu",
  #   "operating_system": "GNU/Linux",
  #   "processor": "x86_64"
  # }

Возвращаемое значение

Ключ	Описание
Возвращаемое значение любой	Обработанный вывод. Возвращаемое значение: success

Авторы

Kelly Brazil (@kellyjonbrazil)

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритетов от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/jc_filter.html