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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.windows.

Чтобы использовать её в плейбуке, укажите: community.windows.win_xml.

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

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

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

Параметры

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

Примечания

Примечание

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

См. также

community.general.xml: Работа с XML на узлах Posix.
Руководство по XPath на w3shools: Полезное руководство по 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 string	Имя созданного файла резервной копии. Возвращается: если backup=yes Пример: `"C:\\Path\\To\\File.txt.11540.20150212-220915.bak"`
count integer	Количество узлов, соответствующих XPath. Возвращается: если count=yes Пример: `33`
err list / элементы=string	Исключения при сравнении XML. Возвращается: всегда для типа element при уровне подробности -vvv или выше Пример: `["attribute mismatch for actual=string"]`
msg string	Выполненное действие. Возвращается: всегда Пример: `"xml added"`

Авторы

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

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

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