{
    "mode": "man",
    "parameter": "solterm",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/solterm/1/json",
    "generated": "2026-06-16T03:05:44Z",
    "synopsis": "",
    "sections": {
        "NAME": {
            "content": "solterm - An IPMI Serial over LAN program\n\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "",
            "subsections": [
                {
                    "name": "solterm",
                    "content": "<connection   parms>   [-e   escapechar]   [-notencrypted]   [-notauthenticated]   [-bitrate\n(9600|19200|38400|57600|115200)] [-alerts (succeed|defer|fail)] [-holdoff]  [-ack-retries  n]\n[-ack-timeout microseconds] [-v] [-q]\n"
                }
            ]
        },
        "DESCRIPTION": {
            "content": "The solterm program allows a user to make a remote serial connection over IPMI.  The requires\nthat the remote system support IPMI 2.0 Serial Over LAN.\n\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "<connection parms>",
                    "content": "The parameters for the connection depend on the connection type.  These  are  all  de‐\nscribed in openipmiconparms (7)\n\n"
                },
                {
                    "name": "-e",
                    "content": "The  character  to use to escape, or exit, the program.  Entering this chatacter right\nafter a newline is entered causes the program to go into command mode.  A single char‐\nacter after this performs a command.  The default escape character is \"~\" as shown be‐\nlow.  Suppported commands are:\n\n~.     Terminate the program\n\n~B     Send a serial BREAK over the connection\n\n~F     Flush all buffers\n\n~R     Assert the Ring Indicator (RI) line\n\n~r     Deassert the Ring Indicator (RI) line\n\n~D     Assert DCD and DSR lines\n\n~d     Deassert DCD and DSR lines\n\n~C     Pause the output using CTS\n\n~c     Put CTS under BMC control\n\n~?     Help on escape commands\n\n~~     Enter the escape character twice to send it.\n\n",
                    "flag": "-e"
                },
                {
                    "name": "-notencrypted",
                    "content": "Do not encrypt the SOL data going over the connection.\n\n"
                },
                {
                    "name": "-notauthenticated",
                    "content": "Do not do integrity checks on the SOL data going over the connection.\n\n"
                },
                {
                    "name": "-bitrate",
                    "content": "Set the bitrate to the given value.  The default is whatever the BMC has set it to.\n\n"
                },
                {
                    "name": "-alerts",
                    "content": "This specifies what to do if a alert that requires a callout occurs on the line.\n\nsucceed\nspecifies that serial/modem alerts are to succeed while SoL is active.\n\ndeferred\nspecifies that serial/modem alerts are to be deferred for the duration  of  the\nSoL session.\n\nfail   specifies  that  serial/modem alerts automatically fail during the SoL session.\nThis is the default.\n\n"
                },
                {
                    "name": "-holdoff",
                    "content": "Specifies that CTS, DTR, and DSR are to be deasserted at the start of the SoL  session\nso that the configuration may be modifeid before the handshake is released.\n\n"
                },
                {
                    "name": "-v",
                    "content": "",
                    "flag": "-v"
                },
                {
                    "name": "-q",
                    "content": "",
                    "flag": "-q"
                }
            ]
        },
        "SEE ALSO": {
            "content": "openipmiconparms(7)\n\n",
            "subsections": []
        },
        "KNOWN PROBLEMS": {
            "content": "None\n\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Darius Davis <dariusd@users.sourceforge.net>\n\n\n\nOpenIPMI                                      05/13/03                                    solterm(1)",
            "subsections": []
        }
    },
    "summary": "solterm - An IPMI Serial over LAN program",
    "flags": [
        {
            "flag": "-e",
            "long": null,
            "arg": null,
            "description": "The character to use to escape, or exit, the program. Entering this chatacter right after a newline is entered causes the program to go into command mode. A single char‐ acter after this performs a command. The default escape character is \"~\" as shown be‐ low. Suppported commands are: ~. Terminate the program ~B Send a serial BREAK over the connection ~F Flush all buffers ~R Assert the Ring Indicator (RI) line ~r Deassert the Ring Indicator (RI) line ~D Assert DCD and DSR lines ~d Deassert DCD and DSR lines ~C Pause the output using CTS ~c Put CTS under BMC control ~? Help on escape commands ~~ Enter the escape character twice to send it."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "Do not encrypt the SOL data going over the connection."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "Do not do integrity checks on the SOL data going over the connection."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "Set the bitrate to the given value. The default is whatever the BMC has set it to."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "This specifies what to do if a alert that requires a callout occurs on the line. succeed specifies that serial/modem alerts are to succeed while SoL is active. deferred specifies that serial/modem alerts are to be deferred for the duration of the SoL session. fail specifies that serial/modem alerts automatically fail during the SoL session. This is the default."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "Specifies that CTS, DTR, and DSR are to be deasserted at the start of the SoL session so that the configuration may be modifeid before the handshake is released."
        },
        {
            "flag": "-v",
            "long": null,
            "arg": null,
            "description": ""
        },
        {
            "flag": "-q",
            "long": null,
            "arg": null,
            "description": ""
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "openipmiconparms",
            "section": "7",
            "url": "https://www.chedong.com/phpMan.php/man/openipmiconparms/7/json"
        }
    ]
}