set buffer

Purpose

Configures buffering settings on a port or displays the port buffer configuration settings on all ports and the total memory available for buffers. The port buffering feature allows you to monitor incoming ASCII serial data in log form.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to one of the following:

For a user to display the port buffering settings for the line on which they are logged in: set permissions buffers=r-self
For a user to display the port buffering settings for any line: set permissions buffers=read
For a user to display and set the port buffering settings for the line on which they are logged in: set permissions buffers=rw-self
For a user to display the port buffering settings for any line, and set port buffering settings for the line on which the user is logged in: set permissions buffers=w-self-r
For a user to display and set the port buffering settings on any line: set permissions buffers=rw

See set permissions for details on setting user permissions for commands.

Syntax

Configure port buffering

set buffer [clear] [port=range] [size=size in kilobytes]
  [state={on|off|paused}]

Display port buffering settings

set buffer [port=port]

Options

clear

Clears the contents of the specified buffer.

port=range

The port or ports to which the command applies.

size=size in kilobytes

The size in kilobytes to configure the buffer. Settings are configurable in 2-kilobyte increments. The maximum size is 64 kilobytes. The default is 32 kilobytes.

state={on|off|paused}

The buffering state, which can be any of the following:

on

The data is buffered.

off

The data is not buffered and all data is cleared from the buffer.

paused

The data is not buffered, but data in the buffer is not cleared.

Examples

Display port buffer configuration for all ports

#> set buffer
tty     state  size(kb)   % usage

  1       off        32         0

Configure buffers

In this example, the set buffer command sets the buffer state for port 1 to on mode and the buffer size to 64 kilobytes.

#> set buffer port=1 state=on size=64