General mpd commands

Mpd 3.18 User Manual : Configuring Mpd : General mpd commands
Previous: Configuring Mpd
Next: Bundle layer 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 defined 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`
`link [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.

`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.

  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.

  ecp

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

  lcp

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

  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 the version of mpd running.

`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 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 login [ name ]`

    Sets the login name required for telnet connections to be `name`, or eliminates any required login if `name` is omitted. The password for `name` is found by looking up `name` in `mpd.secrets`.

  `set radius ...`

    Configures RADIUS authentication:

    `set radius server name secret [ auth-port [ acct-port ]]`

      Configure RADIUS server parameters. Multiple RADIUS servers may be configured by repeating this command.

    `set radius timeout seconds`

      Set the timeout for completion of RADIUS requests.

    `set radius retries #retries`

      Set the number of retries for RADIUS requests.

    `set radius config pathname`

      Set the pathname to the `radius.conf(5)`, if different from the default `/etc/radius.conf`.

    `set radius me IP`

      Send the given IP in the RAD_NAS_IP_ADDRESS attribute to the server.

    `set radius acct-update seconds`

      Set the accounting update interval.

  `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 pppoe ...`

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

`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. Otherwise, the lower layers are opened as well in order to establish a connection.

  bund

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

  ipcp

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

  ccp

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

  lcp

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

  phys

    Device layer. This is normally opened and closed automatically.

  Normally, only the `iface` layer 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 currently active bundle.

`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 3.18 User Manual : Configuring Mpd : General mpd commands
Previous: Configuring Mpd
Next: Bundle layer commands