Mpd 4.4.1 User Manual : Configuring Mpd : General mpd commands
Previous: Configuring Mpd
Next: Global commands

4.1. General mpd commands

This chapter describes general mpd commands that don't apply to a specific layer.

bundle [ name ]

This command changes the currenly active bundle to the bundle named name. The currently active link is also changed, to the first link of the bundle. If no name is given, this command lists all of the defined bundles and their constituent links. The new bundle will be reflected in the prompt.

link [ name | [number] ]

This command changes the currenly active link to the link named name. If this link does not belong to the currently active bundle, then the currently active bundle is changed to the bundle that owns link name. The new link will be reflected in the prompt. Link number (RAD_NAS_PORT) can be specified in hex form in square brackets in place of name.

repeater [ name ]

This command changes the currenly active repeater to the repeater named name. The currently active phys is also changed, to the first phys of the repeater. If no name is given, this command lists all of the defined repeaters and their constituent physes. The new phys will be reflected in the prompt.

phys [ name ]

This command changes the currenly active phys to the phys named name. If this phys does not belong to the currently active bundle/repeater, then the currently active bundle/repeater is changed to the bundle/repeater that owns phys name. If no name is given, this command lists all of the defined physes and their bundles/repeaters. The new phys will be reflected in the prompt.

msession [ msesid ]

This command changes the currenly active bundle to the bundle holding session with multilink session ID msesid.

session [ sesid ]

This command changes the currenly active link to the link holding session with session ID sesid.

load configuration

This command causes mpd to read the entry for configuration out of mpd.conf and execute the corresponding commands, just as if configuration had been specified on the command line. Execution stops at the first blank line.

show [ item ]

This command displays various status information. The valid values for item are:

bundle

Show status information about the currently active bundle.

link

Show status information about the currently active link.

repeater

Show status information about the currently active repeater.

phys

Show status information about the currently active physical device.

iface

Show status information about the interface layer associated with the currently active bundle.

routes

Show the current IP routing table.

mp

Show status information about the multi-link protocol associated with the currently active bundle.

ipcp

Show status information about the IP control protocol associated with the currently active bundle.

ccp

Show status information about the compression control protocol associated with the currently active bundle.

lcp

Show status information about the link control protocol associated with the currently active link.

nat

Show information about NAT on the currently active bundle.

auth

Show status information about Authentication.

eap

Show status information about EAP.

radius

Information relating to RADIUS authentication.

proto

Show protocol statistics for the currently active bundle and link.

types

Show the device types supported by this version of mpd.

layers

Show the names of the layers that are valid as arguments to the open and close commands.

events

Show all pending events (for debugging mpd).

mem

Show distribution of dynamically allocated memory (for debugging mpd).

version

Show running mpd version and supported features.

summary

Show status summary

console

Show console summary

web

Show web server summary

set ...

This command sets various configuration information. Further details are contained in later sections in this chapter. The valid completions for set are:

set bundle ...

Set bundle layer configuration parameters for the currently active bundle.

set link ...

Set link layer configuration parameters for the currently active link.

set iface ...

Set interface layer configuration parameters for the currently active bundle.

set nat ...

Set NAT configuration parameters for the currently active bundle.

set ipcp ...

Set IP control protocol configuration parameters for the currently active bundle.

set ccp ...

Set compression control protocol configuration parameters for the currently active bundle.

set auth ...

Configures the authentication subsystem.

set radius ...

Configures RADIUS.

set eap ...

Configures the EAP.

set debug ...level

Sets the netgraph(3) debugging level. Default is zero.

set modem ...

Sets device specific configuration parameters for the currently active link, which must have type modem.

set ng ...

Sets device specific configuration parameters for the currently active link, which must have type netgraph.

set tcp ...

Sets device specific configuration parameters for the currently active link, which must have type tcp.

set udp ...

Sets device specific configuration parameters for the currently active link, which must have type udp.

set pptp ...

Sets device specific configuration parameters for the currently active link, which must have type pptp.

set l2tp ...

Sets device specific configuration parameters for the currently active link, which must have type l2tp.

set pppoe ...

Sets device specific configuration parameters for the currently active link, which must have type pppoe.

set console ...

Sets console specific configuration parameters

set web ...

Sets web server specific configuration parameters

open [ layer ]

This command causes an OPEN event to be sent to the corresponding layer or finite state machine (FSM). The valid layers are:

iface

Interface layer. Opening this layer configures the interface and installs any routes. If dial-on-demand is enabled, nothing else happens until there is outgoing traffic. If dial-on-demand is disabled there no reason to open this layer manually.

bund

Bundle layer. This layer represents the multi-link bundle ``virtual link'' and is normally opened and closed automatically.

ipcp

IP control protocol FSM. This is normally opened and closed automatically.

ccp

Compression control protocol FSM. This is normally opened and closed automatically.

link

Link control protocol FSM. This is default layer for open/close commands. Opening of this layer initiates outgoing call by this link.

phys

Device layer. This is normally opened and closed automatically.

Normally, only the iface and link layers should be explicitly opened or closed. This is because the other layers are programmed to automatically open and close when appropriate. Note that the SIGUSR1 and SIGUSR2 signals are an alternative way to open and close the first link.

close [ layer ]

This command causes a CLOSE event to be sent to the corresponding layer or finite state machine (FSM).

log [ +/-flag ... ]

Mpd supports several different logging flags. Every line logged by mpd is tagged with one (or more) of these flags. By turning the flags on or off, that particular type of logging is enabled or disabled. This allows you to customize logging verbosity.

Without any arguments, the log command shows the current set of logging flags. To enable a logging flag, add the +flag argument. To disable a logging flag, add the -flag argument.

These are the various flags supported by mpd and their corresponding categories. Those with a * are turned on by default:

auth*

Link authentication events

bund*

Bundle layer events

ccp

Compression events and negotiation

ccp2

Compression more verbosity

ccp3

Compression even more verbosity

chat*

Modem chat script

chat2

Modem chat script more verbosity. Very useful when debugging chat scripts.

console*

Log to the console as well as the log file

echo

Echo/reply packets for all FSM's

frame

Dump all frames transmitted and received

fsm*

All FSM events (except echo and resets)

iface*

Interface layer events

ipcp*

IP control protocol events and negotiation

lcp*

Link control protocol events and negotiation

link*

Link layer events

mp

Multi-link events and negotiation

mp2

Multi-link more verbosity

phys*

Device layer events

pptp*

PPTP device layer high level events

pptp2

PPTP more verbosity

pptp3

PPTP even more verbosity

radius*

RADIUS authentication events

help [ command ]

This gives a brief description of the supplied command, or if an incomplete command is given, lists the available alternatives.

null

This command does nothing.

exit

This command exits the console, but does not quit the mpd process. This command is useful for disconnecting a telnet connection.

quit

Close down all connections and quit the mpd process.


Mpd 4.4.1 User Manual : Configuring Mpd : General mpd commands
Previous: Configuring Mpd
Next: Global commands