mip6config(1M) mip6config(1M)
NAME
mip6config - Mobile IPv6 configuration utility
SYNOPSIS
conf_file]
DESCRIPTION
is the configuration utility for Mobile IPv6. It provides an interface to verify as well as edit the contents of configuration files. For a
description of the format and syntax of the file, see mip6.conf(4). Only superusers can run
Options
recognizes the following command-line options and arguments:
Verifies and displays the contents of a
configuration file. checks for any format, syntax or data type errors in the file. The length of each line in the file is
restricted to 240 characters and the maximum length of any non-commented token is restricted to 60 characters. Ignoring the
argument will start a configuration session where user can use various mip6config commands to edit the contents of the configu-
ration file.
conf_file The configuration file to verify or edit in a configuration session. If conf_file is not provided, is the default.
If the user is starting a configuration session, then reads the the contents of the configuration file into the session. All
unconfigured or illegally configured parameters are initialized to unconfigured. The contents of conf_file will be altered
only if the user issues the command.
Configuration Parameters
mip6mod configuration parameters are grouped in the following three categories:
General and
Binding Cache and
Error Rate and
Commands
commands can be classified into three categories: configuration commands, list commands, and session commands. These commands are docu-
mented below.
Configuration Commands
These commands are of the forms:
The commands can be used to assign values to a group of one or more configuration parameters. The commands can be used to set the values of
a group of related configuration parameters to unconfigured. The input can be used in any command in order to set the value of the config-
uration parameter to unconfigured.
For commands that take arguments, users can invoke the novice mode by executing the command without arguments. In novice mode, user will be
prompted for each parameter configured by the command. The current value for that parameter (if any) is displayed within parentheses in the
prompt, and user can press the key in order to retain that value. User can use the input in order to get help for that argument.
(Abbr.: Configure one or more General, Binding Cache, or Error Rate parameters.
Configures the logging level of Note that also logs messages that are logged at higher levels. For example, for a logging
level of also logs messages for levels and log_level must be one of the following (from highest to lowest levels):
Catastrophic conditions that should be corrected immediately, for example,
exceeding memory space.
Error conditions, for example, binding cache full.
Warnings, for example, dynamic configuration changes.
Informative messages, for example, creation of a binding.
Messages that are useful for debugging and troubleshooting purposes, for
example, addition of mobility route.
The default is
Configures the number of mip6mod instances to start for processing messages with Mobility Header. num_mip6mod_instances must
be in the range [1..N], where N is the number of processors on the system. The number of processors on the system
can be determined by various commands, for example,
The default is
Configures the maximum number of Home Agent and Correspondent Node binding cache entries can support. max_bindings must be
an integer in the range [1..100000]. must be greater than or equal to
The default is or whichever is higher.
Configures the maximum number of Home Agent binding cache entries can support. max_home_bindings must be an integer in the
range [1..100000]. must be less than or equal to
The default is or whichever is lower.
Configures the maximum lifetime (in seconds) allocated to binding cache entries. max_binding_lifetime must be an integer in
the range [1..262140].
The default is
Configures the advice time (in seconds) in the Binding Refresh Advice option. includes the Binding Refresh Advice option in
the Binding Acknowledgment message only if is the Home Agent to the Mobile Node. The Binding Refresh Advice option
advises the Mobile Node how many seconds prior to the expiration of the current registration that it should re-
register. binding_refresh_advice_interval must be an integer in the range [0..262140]. The value disables the
inclusion of the Binding Refresh Advice option in the Binding Acknowledgment message. must be less than
The default is
Configures the number of seconds prior to the expiration of the binding when sends the Binding Refresh Request message to the
Mobile Node. sends the Binding Refresh Request message only if it is a Correspondent Node to the Mobile Node. The
Binding Refresh Request message prompts the Mobile Node to re-register as soon as possible. bind-
ing_refresh_request_threshold must be an integer in the range [0..420]. A value of disables the sending of the
Binding Refresh Request message. must be less than
The default is
Configures the number of error messages sent before error message rate is controlled. error_rate_limit_threshold must be an
integer in the range [1..32].
The default is
Configures the maximum rate at which error messages are sent when error rate is controlled. Use an integer in the range
[10..9990]. Note that smaller values are faster rates, and the value will be the shortest duration (in millisec-
onds) between error messages. must be faster than
The default is however, if is faster than 100, the default is 10 milliseconds faster than
Configures the minimum rate at which error messages are sent when error rate is controlled. Use an integer in the range
[20..10000]. Note that smaller values are faster rates, and the value will be the longest duration (in millisec-
onds) between error messages. must be slower than
The default is however, if is slower than 1000, the default is 10 milliseconds slower than
(Abbr.:
Configure Binding Cache
parameters in novice mode.
(Abbr.:
Configure Error Rate parameters in novice mode.
(Abbr.:
Configure General parameters in novice mode.
(Abbr.:
Set the values of all General, Binding Cache, and Error Rate parameters to unconfigured.
(Abbr.:
Set the values of all Binding Cache parameters to unconfigured.
(Abbr.:
Set the values of all Error Rate parameters to unconfigured.
(Abbr.:
Set the values of all General parameters to unconfigured.
List Commands
These commands list the values assigned to the configuration parameters. For those parameters whose value is unconfigured, the commands
display the default value for that parameter in parentheses.
(Abbr.: List values of all General, Binding Cache, and Error Rate parameters.
(Abbr.:
List values all Binding Cache parameters.
(Abbr.:
List the values of all Error Rate parameters.
(Abbr.:
List the values of all General parameters.
Session Commands
The remaining commands can be classified as session commands.
(Abbr.: Create a configuration file from session data, including comments describing each parameter. Before creating the file, will verify
the configuration data and warn users about any errors. Even if errors are detected, the tool still creates a configuration file. For each
parameter that is set to unconfigured in the session, writes the corresponding parameter label as a comment in the configuration file.
[filename] The absolute or fully-qualified configuration file path name to write the mip6config session to. If filename is differ-
ent from the conf_file command line argument, and if filename already exists, user will be prompted to confirm the
action. Note that any existing contents in filename will be overwritten by this command.
(Abbr.:
Exit from
This forces to exit even if the current configuration session is unsaved.
(Abbr.:
Obtain syntax and help information for all commands.
Use this switch as the first argument to get help information on any arguments
of command.
[command] The mip6config command to get help information on. Repeat this argument as needed. Omit this argument to get list of
all commands supported.
(Abbr.:
Clear the session terminal (similar to the shell command
(Abbr.:
Display an overview of the process to configure
RETURN VALUE
Upon completion, returns one of the following exit values:
There were no errors found in verifying the contents of a configuration file
(reading in or writing to).
There were errors found in verifying the contents of a configuration file.
(reading in or writing to).
EXAMPLES
Verify and display configuration file
Read in contents of default configuration file and start a session
Example Session
Start session by reading in contents of configuration file
Configure binding cache size to 5000, max home bindings to 2000 and binding lifetime to 300 seconds
Use novice mode command to configure log level to warn and number of mip6mod instances to 2:
List all parameters
Obtain help on commands and
Write session records to file
Exit
FILES
Default configuration file for
Auto-start configuration file for
MUX ID file for all
instances started by
AUTHOR
was developed by Hewlett-Packard Company.
SEE ALSO
top(1), mip6admin(1M), mip6config(1M), rtradvd(1M), rtradvd.conf(4), mip6mod(7).
IETF Document Mobility Support in IPv6
IETF Document Using IPsec to Protect Mobile IPv6 Signaling between Mobile Nodes and Home Agents
mip6config(1M)