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

Примечание

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

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

Для использования в playbook укажите: 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.
Учебник 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: 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:\Path\To\File.txt.11540.20150212-220915.bak
count целое число	если count=да	Количество узлов, соответствующих xpath. Пример: 33
err список / элементы=строка	всегда, для типа element и -vvv или более	Исключения сравнения XML. Пример: несоответствие атрибутов для actual=строка
msg строка	всегда	Что было выполнено. Пример: xml добавлен

Авторы

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

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