Модуль community.windows.win_xml — Управление содержимым XML-файлов на хостах Windows

Примечание

Этот модуль входит в коллекцию community.windows (версия 2.3.0).

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

Для установки используйте: ansible-galaxy collection install community.windows.

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

Обзор
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Управляет узлами XML, атрибутами и текстом, используя xpath для выбора узлов XML, которые необходимо управлять.
XML-фрагменты, отформатированные как строки, используются для указания желаемого состояния части или частей XML-файлов на удаленных серверах Windows.
Для целей, отличных от Windows, используйте модуль community.general.xml вместо него.

Параметры

Параметр	Комментарии
attribute строка	Имя атрибута, если тип — ‘attribute’. Требуется, если `type=attribute`.
backup логическое значение	Определяет, следует ли создавать резервную копию. При установке в `yes`, создается резервная копия файла с информацией о времени, чтобы вы могли восстановить исходный файл, если каким-то образом неправильно его перезаписали. Варианты: `false` ← (по умолчанию) `true`
count логическое значение	Если установлено в `yes`, возвращает количество узлов, соответствующих xpath. Варианты: `false` ← (по умолчанию) `true`
fragment aliases: xmlstring строка	Строковое представление XML-фрагмента, ожидаемого по xpath. С Ansible 2.9 не требуется, когда state=absent или когда count=yes.
path aliases: dest, file путь / обязательно	Путь к файлу для обработки.
state строка	Установите или удалите узлы (или атрибуты), соответствующие xpath. Варианты: `"present"` ← (по умолчанию) `"absent"`
type строка	Тип XML-узла, с которым вы работаете. Варианты: `"attribute"` `"element"` ← (по умолчанию) `"text"`
xpath строка / обязательно	XPath для выбора узла или узлов для обработки.

Примечания

Примечание

Поддерживает только работу с XML-элементами, атрибутами и текстом.
Типы узлов пространства имен, инструкций обработки, команд и документов нельзя изменить с помощью этого модуля.

См. также

community.general.xml: Обработка XML для хостов Posix.
w3shools XPath tutorial: Полезный учебник по XPath

Примеры

- name: Apply our filter to Tomcat web.xml
  community.windows.win_xml:
    path: C:\apache-tomcat\webapps\myapp\WEB-INF\web.xml
    fragment: '<filter><filter-name>MyFilter</filter-name><filter-class>com.example.MyFilter</filter-class></filter>'
    xpath: '/*'

- name: Apply sslEnabledProtocols to Tomcat's server.xml
  community.windows.win_xml:
    path: C:\Tomcat\conf\server.xml
    xpath: '//Server/Service[@name="Catalina"]/Connector[@port="9443"]'
    attribute: 'sslEnabledProtocols'
    fragment: 'TLSv1,TLSv1.1,TLSv1.2'
    type: attribute

- name: remove debug configuration nodes from nlog.conf
  community.windows.win_xml:
    path: C:\IISApplication\nlog.conf
    xpath: /nlog/rules/logger[@name="debug"]/descendant::*
    state: absent

- name: count configured connectors in Tomcat's server.xml
  community.windows.win_xml:
    path: C:\Tomcat\conf\server.xml
    xpath: //Server/Service/Connector
    count: true
  register: connector_count

- name: show connector count
  ansible.builtin.debug:
    msg: Connector count is {{ connector_count.count }}

- name: ensure all lang=en attributes to lang=nl
  community.windows.win_xml:
    path: C:\Data\Books.xml
    xpath: //@[lang="en"]
    attribute: lang
    fragment: nl
    type: attribute

Значения возврата

Общие значения возврата документированы здесь, следующие — это поля, уникальные для данного модуля:

Ключ	Описание
backup_file строка	Имя резервной копии файла, который был создан. Возвращается: если backup=yes Пример: `"C:\\Path\\To\\File.txt.11540.20150212-220915.bak"`
count целое число	Количество узлов, соответствующих XPath. Возвращается: если count=yes Пример: `33`
err список / элементы=строка	Исключения сравнения XML. Возвращается: всегда, для типа элемент и -vvv или более Пример: `["attribute mismatch for actual=string"]`
msg строка	Выполненные действия. Возвращается: всегда Пример: `"xml added"`

Авторы

Richard Levenberg (@richardcs)
Jon Hawkesworth (@jhawkesworth)

Ссылки на сборку

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