XML Agent

XML Agent configuration on IOS-XR enables XML-based management interfaces for device automation. The default agent handles standard XML requests, while TTY and SSL transports provide alternative access methods. Each transport supports tuning parameters for streaming size, iteration size, throttle rates, memory limits, and session timeouts. VRF-scoped access control lists restrict which networks can reach the agent.

Diagram

Classes

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
xml_agent	Class	`[xml_agent]`	No

xml_agent (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	Yes
ipv6_enable	Boolean	`true`, `false`	No
iteration	Any	Choice[`off`] or Integer[min: `1`, max: `100000`] or String[Regex: `^.[\$\%]\{.$`]	No
session_timeout	Integer	min: `1`, max: `1440`	No
streaming_size	Integer	min: `1`, max: `100000`	No
throttle_memory	Integer	min: `100`, max: `1024`	No
throttle_process_rate	Integer	min: `1000`, max: `30000`	No
tty	Class	`[tty]`	No
ssl	Class	`[ssl]`	No
vrfs	List	`[vrfs]`	No

tty (iosxr.devices.configuration.xml_agent)

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
iteration	Any	Choice[`off`] or Integer[min: `1`, max: `100000`] or String[Regex: `^.[\$\%]\{.$`]	No
session_timeout	Integer	min: `1`, max: `1440`	No
streaming_size	Integer	min: `1`, max: `100000`	No
throttle_memory	Integer	min: `100`, max: `1024`	No
throttle_process_rate	Integer	min: `1000`, max: `30000`	No

ssl (iosxr.devices.configuration.xml_agent)

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
iteration	Any	Choice[`off`] or Integer[min: `1`, max: `100000`] or String[Regex: `^.[\$\%]\{.$`]	No
session_timeout	Integer	min: `1`, max: `1440`	No
streaming_size	Integer	min: `1`, max: `100000`	No
throttle_memory	Integer	min: `100`, max: `1024`	No
throttle_process_rate	Integer	min: `1000`, max: `30000`	No
vrfs	List	`[vrfs]`	No

vrfs (iosxr.devices.configuration.xml_agent)

Name	Type	Constraint	Mandatory
name	String		Yes
ipv4_access_list	String		No
ipv6_access_list	String		No
shutdown	Boolean	`true`, `false`	No

vrfs (iosxr.devices.configuration.xml_agent.ssl)

Name	Type	Constraint	Mandatory
name	String		Yes
ipv4_access_list	String		No
shutdown	Boolean	`true`, `false`	No

Example YAML Code:

Example-1: Enable XML agent with IPv4/IPv6 support, tuning and VRF access lists.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        xml_agent:
          enable: true
          ipv6_enable: true
          streaming_size: 1000
          iteration: off
          throttle_process_rate: 5000
          throttle_memory: 300
          session_timeout: 30
          vrfs:
            - name: default
              ipv4_access_list: ACL_V4
              ipv6_access_list: ACL_V6
            - name: MGMT
              ipv4_access_list: MGMT_ACL

Example-2: Enable TTY and SSL transports with SSL VRF configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        xml_agent:
          enable: true
          tty:
            streaming_size: 1000
            iteration: 48
            throttle_process_rate: 5000
            throttle_memory: 300
            session_timeout: 30
          ssl:
            streaming_size: 1000
            iteration: off
            throttle_process_rate: 5000
            throttle_memory: 300
            session_timeout: 30
            vrfs:
              - name: default
                ipv4_access_list: ACL_V4
              - name: MGMT
                ipv4_access_list: MGMT_ACL

Example-3: Enable TTY and SSL transports with no additional attributes.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        xml_agent:
          enable: true
          tty:
            enable: true
          ssl:
            enable: true