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

Примечание

Этот плагин входит в состав коллекции community.windows (версия 1.2.0).

Для его установки используйте: 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`, создаётся резервный файл, включающий отметку времени, чтобы вы могли получить исходный файл, если его случайно повредили.
count логическое значение	Варианты: нет ← да	При установке в `yes`, возвращает количество узлов, соответствующих xpath.
fragment строка		Строковое представление XML-фрагмента, ожидаемого в xpath. С Ansible 2.9 не требуется при state=absent или при count=yes. Псевдонимы: xmlstring
path путь / требуется		Путь к файлу, над которым нужно произвести операцию. Псевдонимы: dest, file
state строка	Варианты: present ← absent	Устанавливает или удаляет узлы (или атрибуты), соответствующие xpath.
type строка / требуется	Варианты: attribute element ← text	Тип XML-узла, с которым вы работаете.
xpath строка / требуется		XPath для выбора узла или узлов, над которыми нужно произвести операцию.

Примечания

Примечание

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

См. также

community.general.xml: Обработка XML для систем Posix.
w3shools Руководство по XPath: Полезное руководство по 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: yes
  register: connector_count

- name: show connector count
  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=да	Имя созданного резервного файла. Пример: C:\Путь\К\Файлу.txt.11540.20150212-220915.bak
count целое число	если count=да	Количество узлов, соответствующих xpath. Пример: 33
err список / элементы=строка	всегда, для типа element и -vvv или более	Исключения при сравнении XML. Пример: Несовпадение атрибутов для actual=string
msg строка	всегда	Что было сделано. Пример: xml добавлен

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/windows/win_xml_module.html