17370845950

如何用Ansible的xml模块修改配置文件
Ansible的xml模块基于Python内置ElementTree,支持读写XML配置,但不支持命名空间和高级XPath;修改属性需用state: present+attribute,添加节点用xpath定位父节点并设attribute/content,删除用state: absent,操作前应备份。

Ansible 的 xml 模块可用于读取、修改、添加或删除 XML 配置文件中的节点和属性,适合处理如 Tomcat、Maven、Jenkins 等工具的 XML 配置。它不依赖外部解析器(如 lxml),而是使用 Python 内置的 xml.etree.ElementTree,因此轻量但功能有限——不支持命名空间、XPath 表达式较基础,且不能格式化输出(缩进/换行会丢失)。

确认目标 XML 文件结构

使用 xml 模块前,先用 catansible.builtin.debug 查看原始内容,明确要操作的标签层级、属性名和文本值。例如:

Tomcat 的 server.xml 中一个 Connector 节点:

若需把 port 改为 8081,就要定位到该 Connector 元素,并修改其 port 属性。

修改 XML 属性值

state: present + attribute 参数更新属性。必须指定唯一标识路径(path)和匹配条件(attributecontent)。

  • 只改 port 属性(按现有属性匹配):
    xml:
    path: /opt/tomcat/conf/server.xml
    xpath: /Server/Service/Connector[@port='8080']
    attribute: port
    value: '8081'
    state: present
  • 多个条件匹配更稳妥(比如同时看 protocol 和 port):
    xpath: /Server/Service/Connector[@protocol='HTTP/1.1' and @port='8080']
  • 注意: xpath 必须写全路径;属性值带单引号时,YAML 中要用双引号包裹整个 xpath 字符串,避免解析错误。

添加或替换 XML 节点内容

通过 state: present 设置 content 可写入文本内容;设置 attribute 可写入属性值;两者可同时用。

  • 给某个 Context 添加 reloadable="true" 属性:
    xpath: /Server/Service/Engine/Host/Context[@docBase='myapp']
    attribute: reloadable
    value: 'true'
  • 标签内插入文本(如日志路径):
    xpath: /Server/Service/Engine/Host/Valve[@className='org.apache.catalina.valves.AccessLogValve']
    content: '/var/log/tomcat/access.log'
    state: present
  • 新增一个完整子节点(需确保父节点存在):
    xpath: /Server/Service/Engine/Host
    name: Context
    attribute: {'docBase': 'newapp', 'path': '/new'}
    state: present

删除节点或属性

state: absent 删除匹配到的节点或属性。

  • 删掉某个 Connector:
    xpath: /Server/Service/Connector[@port='8009']
    state: absent
  • 只删某个属性(如删掉 redirectPort):
    xpath: /Server/Service/Connector[@port='8080']
    attribute: redirectPort
    state: absent
  • 注意: 删除操作不可逆,建议配合 backup: yes 自动备份原文件。