iteration
To configure the iteration size for large XML agent responses, use the iteration command in xml agent configuration mode. To revert to the default iteration settings, use the no form of this command.
iteration {off | on size iteration-size}
no iteration
Syntax Description
off |
Disables iteration, meaning that the entire XML response is returned, regardless of its size. Use of this option is not recommended. |
on |
Enables iteration, meaning that large XML responses are broken into chunks according to the iteration chunk size. |
size iteration-size |
Specifies the size of the iteration chunk, in Kbytes. Values can range from 1 to 100,000. |
Command Default
Iteration is enabled; the iteration-size is 48.
Command Modes
XML agent
TTY XML agent
SSL XML agent
Command History
Release | Modification |
---|---|
Release 3.9.0 |
This command was introduced. |
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
When the XML agent returns a large response, it splits the response into chunks and returns one chunk at a time. External clients then need to send a GetNext request to obtain the next chunk. Use the iteration command to control the size of iteration chunks. A larger chunk value allows larger chunks to be received in a shorter period of time, possibly making the router system busier. A smaller chunk value allows smaller chunks to be received over a longer period of time, but does not make the router busy You can also specify to disable iteration completely using the iteration off command.
Note |
It is not recommended to disable iteration, since this could result in large transient memory usage. |
To specify the TTY or SSL iteration size specifically, use the iteration command from the appropriate command mode.
Task ID
Task ID |
Operations |
---|---|
config-services |
read, write |
Examples
The following example shows how to configure the iteration chunk size to 100 Kbytes.
RP/0/RSP0/CPU0:router(config)# xml agent
RP/0/RSP0/CPU0:router(config-xml)# iteration on size 100
The following example shows how to disable iteration:
RP/0/RSP0/CPU0:router(config)# xml agent
RP/0/RSP0/CPU0:router(config-xml)# iteration off
The following example shows how to turn on iteration with the default iteration size:
RP/0/RSP0/CPU0:router(config)# xml agent
RP/0/RSP0/CPU0:router(config-xml)# no iteration off
The following example shows how to change the iteration size to the default iteration size.
RP/0/RSP0/CPU0:router(config)# xml agent
RP/0/RSP0/CPU0:router(config-xml)# no iteration on size 100
The following example shows how to change the iteration size of the TTY agent to 3 Kbytes:
RP/0/RSP0/CPU0:router(config)# xml agent tty
RP/0/RSP0/CPU0:router(config-xml-tty)# iteration on size 3
The following example shows how to turn off the iteration of the SSL agent:
RP/0/RSP0/CPU0:router(config)# xml agent ssl
RP/0/RSP0/CPU0:router(config-xml-ssl)# iteration off