mip6admin(1M) mip6admin(1M)
NAME
mip6admin - Mobile IPv6 administration utility
SYNOPSIS
home_address] home_address]
interface_name]
[option]
log_file] log_level]
interface_name]
log_level] num_mip6mod_instances] max_bindings] max_home_bindings] binding_lifetime] binding_refresh_advice_interval] bind-
ing_refresh_request_threshold] rate_limit] error_rate_max] error_rate_min] conf_file]
conf_file]
DESCRIPTION
is a program for performing Mobile IPv6 administrative tasks, such as starting and stopping the Mobile IPv6 Streams Module mip6mod(1M), and
for reporting Mobile IPv6 data, such as configuration and statistics. The tool can interact with and the IPv6 Router Advertisement daemon
rtradvd(1M). Only superusers can run
is used during bootup time to start Auto start (including configuration file) can be specified in the Mobile IPv6 Startup Configuration
file This file is read by the start script If the Startup Configuration file specifies that Mobile IPv6 should be started, the start script
executes command.
communicates with in order to report Mobile IPv6 information such Dynamic Home Agent Address Discovery statistics, Home Agent lists, etc.
can report this information only if is configured for a Home Agent. See rtradvd.conf(4) for more information.
Commands
Usage of commands is restricted based on whether is running on the system. For instance, the user cannot use commands that report data from
(example, when the module is not detected. Conversely, if the module is detected, the user cannot use the command. The detection process is
executed whenever is executed, as well as after the and commands are executed.
commands can be executed as command line arguments to the program or in a session. To start a session, execute without any command line
arguments. Multiple commands can be specified simultaneously at the command line or at the session prompt. To exit a session use the or
commands.
recognizes the following commands.
(Abbr.: Report or delete bindings maintained by Using without the or options lists all the bindings maintained by
(Abbr.: Lists the binding cache entry for the Mobile Node address home_address. This argument may be repeated in
order to list multiple binding cache entries.
(Abbr.: Delete the binding cache entry for the Mobile Node address home_address. This argument may be repeated
in order to delete multiple binding cache entries.
(Abbr.: Clear the session terminal.
(Abbr.: Report and toggle one or more debug settings. Toggle multiple debug settings by using multiple options. Using without an option
reports current debug settings.
(Abbr.: Toggle on or off setting.
(Abbr.: Toggle on or off setting.
(Abbr.: Toggle on or off setting.
(Abbr.: Toggle on or off the setting.
(Abbr.: Exit mip6admin.
(Abbr.: Flush prefix and binding cache lists. Use the command with an option to specify which list to flush. Use the command without an
option to flush both the prefix and binding cache lists. You are required to confirm the lists to flush unless the argument is
used.
Abbr.: You can skip the confirmation step by using this as the first argument to the command and specifying which list
to flush. No lists are flushed if you use this argument without specifying the lists to flush.
(Abbr.: Flush binding cache entries.
(Abbr.: Flush prefix lists for all interfaces.
(Abbr.: Report configuration data, including version, and the configuration file name. Note that the configuration file name will not be
reported if is not configured for a Home Agent.
(Abbr.: Report Home Agent lists from rtradvd daemon.
The name of the the interface to report. Repeat this option to specify
multiple interfaces to report. Ignoring this option reports data for all interfaces rtradvd maintains
Home Agent lists for.
(Abbr.: Obtain help information on commands.
The command to obtain help information on. Use multiple commands as options to obtain help information on multiple
commands. Using help without an option lists and briefly describes all commands.
(Abbr.: Report events logged by via syslogd(1M). This command may be used even when is not running.
(Abbr.: The logfile containing the log entries to display. The default logfile is used if this option is ignored.
(Abbr.: The log level of the events to display. Repeat this option to obtain events for multiple levels. Do not use
this option in order to display events for all log levels. Acceptable inputs to log_level are:
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.
(Abbr.: Report prefix information from and For each prefix reported by the information reported by are displayed along with, in parenthe-
ses, the corresponding information reported by If the values are displayed as 'unknown', it means that the prefix was not
reported by that entity ( or For example, if the information in parentheses are displayed as 'unknown' for a particular prefix,
then it means that did not report the prefix and only did.
(Abbr.: Quit mip6admin.
(Abbr.: Report a comprehensive view of Mobile IPv6. Shows data reported by the following commands: and
(Abbr.: Report or reset statistical counters maintained by The counters are related to Router Advertisements and Solicitations (count and
errors), Dynamic Home Agent Address Discovery and Prefix solicitations (requests and failures). These counters are maintained
per interface.
(Abbr.: Reset the statistical counters. If used, this argument must be the first argument to the command. Ignoring
will report the statistical counters.
The name of the interface to reset or report. Repeat this option to
specify multiple interfaces to report or reset. Ignoring this option will perform the action for all
interfaces maintains counters for.
(Abbr.:
Dynamically reconfigure instances running in the kernel. Use either individual options, or, data in a mip6mod configuration file
-- do not use both. When individual options are used, current information is retained for those configuration parameters not
reconfigured. When a configuration file is used, defaults are used for all parameters not configured in the file. See for
information on the default values of all configuration parameters. This command does not support reducing the number of
instances. Note that when reconfiguration is done via individual inputs, the modifications are lost when is stopped.
Reconfigures the logging level of Note that also logs messages that are logged at higher levels. For example, for a log-
ging level of also logs messages for levels and log_level must be one of the following (from highest to low-
est 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.
Reconfigures 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, Since command does not support reducing the
number of mip6mod instances, num_mip6mod_instances must not be lesser than the value of in the existing con-
figuration.
Reconfigures 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] and must be greater than or equal to (reconfigured in the command or
retained from existing configuration).
Reconfigures the maximum number of Home Agent binding cache entries can support. max_home_bindings must be an integer in
the range [1..100000] and must be less than or equal to (reconfigured in the command or retained from exist-
ing configuration).
Reconfigures the maximum lifetime (in seconds) allocated to binding cache entries. binding_lifetime must be an integer in
the range [1..262140]. It must be greater than and (reconfigured in the command or retained from existing
configuration).
Reconfigures 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 regis-
tration that it should re-register. binding_refresh_advice_interval must be an integer in the range
[0..262140] and must be less than (reconfigured in the command or retained from existing configuration). The
value disables the inclusion of the Binding Refresh Advice option in the Binding Acknowledgment message.
Reconfigures 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.
binding_refresh_request_threshold must be an integer in the range [0..420] and must be less than (reconfig-
ured in the command or retained from existing configuration). A value of disables the sending of the Binding
Refresh Request message.
Reconfigures 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].
Reconfigures 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 mil-
liseconds) between error messages. error_rate_max must be an integer in the range [10..9990] and must be
faster than (reconfigured in the command or retained from existing configuration).
Reconfigures 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 mil-
liseconds) between error messages. error_rate_min must be an integer in the range [20..10000] and and must
be slower than (reconfigured in the command or retained from existing configuration).
Sets the configuration based on a
configuration file. will not perform reconfiguration if there any errors in conf_file (bad format, out of
range values, related parameters out of sync, etc). Defaults are used for all parameters not configured in
the file. See mip6.conf(4) for information about configuration files.
(Abbr.: Start and configure For each instance of successfully started, the MUX ID of the module is written to the file This file is cru-
cial in order for the command to execute properly.
(Abbr: The name of the configuration file. Defaults are used for all parameters that are out of range or miss-
ing. See for information on the default values of all configuration parameters. is the default file if
this option is ignored.
(Abbr.: Report or reset the general, binding, or return routability statistical counters maintained by Use the options to specify which
action (report or reset) to perform on one or more of the counter groups. To perform an action for all counter groups, use an
action option without specifying a counter group option.
(Abbr.: Resets the counters. Must be first option used. reports the counters when this option is not used.
(Abbr.: Mobility Header Packet related counters (errors, number and type of packets sent and received, etc).
(Abbr.: Binding Update related counters (errors, number and type of binding acknowledgement messages sent, number and type
of binding error messages sent, etc).
Return Routability protocol related counters (Number of errors Home Test Init
and Care-of Test Init messages, etc).
(Abbr.: Stop reads each MUX ID in the file and stops the corresponding instance of mip6mod.
RETURN VALUE
Upon completion, returns one of the following exit values:
If any of the following conditions are encountered
a. Errors in the configuration file and commands.
b. Failures in starting or stopping
c. Errors in issuing IOCTL calls to communicate with
d. Errors in communicating with
e. Incorrect usage of commands.
If none of the above error conditions are encountered.
EXAMPLES
Start using default file /etc/mip6.conf
Reset statistical counters for interface lan1 in
Toggle debug setting for "Disable Binding Update Processing"
Retrieve Return Routability statistical counters from
Dynamically reconfigure to set Maximum Binding Lifetime of 600 seconds and Log Level to info. Verify by executing getconfiguration.
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
mip6admin(1M)