MODIFY command: OMPROUTE

You can control OMPROUTE from the operator console using the MODIFY command.

Format


>>-+-MODIFY-+--procname--,-------------------------------------->
   '-F------'                

>--+-KILL------------------------------------------------------------------+-><
   +-RECONFIG--------------------------------------------------------------+   
   +-ROUTESA=--+-ENABLE--+-------------------------------------------------+   
   |           '-DISABLE-'                                                 |   
   +-TRACE=trace_level-----------------------------------------------------+   
   +-DEBUG=debug_level-----------------------------------------------------+   
   +-TRACE6=trace6_level---------------------------------------------------+   
   +-DEBUG6=debug6_level---------------------------------------------------+   
   +-SADEBUG=sadebug_level-------------------------------------------------+   
   +-OSPF-| OSPF options |-------------------------------------------------+   
   +-RIP-| RIP options |---------------------------------------------------+   
   +-GENERIC-| GENERIC options |-------------------------------------------+   
   +-RTTABLE-+-----------------------+-+---------------+-------------------+   
   |         '-,PRtable=--+-ALL----+-' +-,DEST=ip_addr-+                   |   
   |                      '-prname-'   '-,DELETED------'                   |   
   +-IPV6OSPF-| IPv6 OSPF options |----------------------------------------+   
   +-IPV6RIP-| IPv6 RIP options |------------------------------------------+   
   +-GENERIC6-| GENERIC6 options |-----------------------------------------+   
   +-RT6TABLE--+-----------------------+--+------------------------------+-+   
   |           '-,PRtable=--+-ALL----+-'  +-,DEST=-+-ip_addr-----------+-+ |   
   |                        '-prname-'    |        '-ip_addr/prefixlen-' | |   
   |                                      '-,DELETED---------------------' |   
   '-,OPTIONS--------------------------------------------------------------'   

OSPF options

|--+-,LIST--+-,ALL--------+----------------------+--------------|
   |        +-,AREAS------+                      |   
   |        +-,InterFaceS-+                      |   
   |        +-,NBMA-------+                      |   
   |        +-,NeighBoRS--+                      |   
   |        '-,VLINKS-----'                      |   
   +-| LSA command |-----------------------------+   
   +-,AREASUM------------------------------------+   
   +-,EXTERNAL-----------------------------------+   
   +-,DATABASE--+-----------------+--------------+   
   |            '-,AREAID=area_id-'              |   
   +-,DBSIZE-------------------------------------+   
   +-,InterFace--+-----------------------------+-+   
   |             '-,NAME=if_name-+-----------+-' |   
   |                             +-,ACTIVATE-+   |   
   |                             '-,SUSPEND--'   |   
   +-,NeighBoR--+-----------------+--------------+   
   |            '-,IPADDR=ip_addr-'              |   
   +-,ROUTERS------------------------------------+   
   +-,STATiStics---------------------------------+   
   '-,WEIGHT--,NAME=name--,COST=cost-------------'   

LSA command

|--,LSA--,LSTYPE=ls_type--,LSID=lsid---------------------------->

>--,ORIGinator=ad_router--+-----------------+-------------------|
                          '-,AREAID=area_id-'   

RIP options

|--+-,LIST--+-,ALL--------+--------+----------------------------|
   |        +-,InterFaceS-+        |   
   |        '-,ACCEPTED---'        |   
   +-,InterFace--+---------------+-+   
   |             '-,NAME=if_name-' |   
   '-FILTERS-----------------------'   

GENERIC options

|--+-,LIST--+-,ALL--------+-+-----------------------------------|
   |        '-,InterFaceS-' |   
   '-,InterFace-------------'   

IPv6 OSPF options

|--+-,ALL---------------------------------------------+---------|
   +-,AREASUM-----------------------------------------+   
   +-,InterFace--+--------------------------------+---+   
   |             +-,NAME=--if_name--+-----------+-+   |   
   |             |                  +-,ACTIVATE-+ |   |   
   |             |                  '-,SUSPEND--' |   |   
   |             '-,ID=--if_id--+-----------+-----'   |   
   |                            +-,ACTIVATE-+         |   
   |                            '-,SUSPEND--'         |   
   +-,VLINK--+------------------+---------------------+   
   |         '-,ENDPT=router-id-'                     |   
   +-,NeighBoR--+-----------------------------------+-+   
   |            '-,ID=router-id-+-----------------+-' |   
   |                            '-,IFNAME=if_name-'   |   
   +-,DBSIZE------------------------------------------+   
   +-| IPv6 LSA command |-----------------------------+   
   +-,EXTERNAL----------------------------------------+   
   +-,DATABASE--+-----------------+-------------------+   
   |            '-,AREAID=area_id-'                   |   
   +-,ROUTERS-----------------------------------------+   
   +-,STATiStics--------------------------------------+   
   '-,WEIGHT--,NAME=name--,COST=cost------------------'   

IPv6 LSA command

|--,LSA--,LSTYPE=ls_type--,LSID=lsid--,ORIGinator=ad_router--+-----------------+--+-----------------+--|
                                                             '-,AREAID=area_id-'  '-,IFNAME=if_name-'   

IPv6 RIP options

|--+-,ALL--------------------------+----------------------------|
   +-,ACCEPTED---------------------+   
   +-,InterFace--+---------------+-+   
   |             '-,NAME=if_name-' |   
   '-,FILTERS----------------------'   

GENERIC6 options

|--+-,ALL--------------------------+----------------------------|
   '-,InterFace--+---------------+-'   
                 '-,NAME=if_name-'

Parameters

procname

The name of the member in a procedure library that was used to start OMPROUTE.

OPTIONS

Specifies that the global configuration options information is to be displayed.

KILL

Stop the OMPROUTE function.

RECONFIG

Reread the OMPROUTE configuration file. This command ignores all statements in the configuration file except new OSPF_Interface, RIP_Interface, Interface, IPv6_RIP_Interface, and IPv6_Interface statements.

Rule: If you do not have GLOBAL_OPTIONS IGNORE_UNDEFINED_INTERFACES=YES coded in your OMPROUTE configuration, these new configuration statements must be reread from the configuration file by using this command before the interface is first configured to the TCP/IP stack. If you have coded GLOBAL_OPTIONS IGNORE_UNDEFINED_INTERFACES=YES in your OMPROUTE configuration file, you can use OMPROUTE reconfiguration to add a definition for an interface that has been defined to the stack but that is ignored by OMPROUTE. However, OMPROUTE does not associate the interface with the new definition until the interface has been deleted from the stack and then re-added.

ROUTESA=ENABLE|DISABLE

Enable or disable the OMPROUTE subagent.

Note: To change any other value on the ROUTESA_CONFIG statement, the OMPROUTE application must be recycled.

TRACE=trace_level

Start, stop, or change the level of OMPROUTE tracing for initialization and IPv4 routing protocols. The different trace levels available and their descriptions are as follows:

TRACE=0: Turns off OMPROUTE tracing.
TRACE=1: Gives all the informational messages.
TRACE=2: Gives the informational messages plus formatted packet tracing.

Attention: OMPROUTE tracing affects OMPROUTE performance and might require increasing the Dead_Router_Interval on OSPF interfaces to keep neighbor adjacencies from collapsing.

DEBUG=debug_level

Level of debugging for OMPROUTE to use for initialization and IPv4 routing protocols. The following values are valid:

DEBUG=0 turns off OMPROUTE IPv4 and initialization debugging.
DEBUG=1 provides internal debug messages.
DEBUG=2 provides the same information as DEBUG=1 plus hexadecimal packet tracing.
DEBUG=3 provides the same information as DEBUG=2 plus module entry and exit.
DEBUG=4 provides the same information as DEBUG=3 plus task add and run.

TRACE6=trace6_level

Start, stop, or change the level of OMPROUTE tracing for IPv6 routing protocols. The different trace levels available and their descriptions are as follows:

TRACE6=0: Turns off OMPROUTE tracing.
TRACE6=1: Gives all the informational messages.
TRACE6=2: Gives the informational messages plus formatted packet tracing.

Attention: OMPROUTE tracing affects OMPROUTE performance and might require increasing the Dead_Router_Interval on OSPF interfaces to keep neighbor adjacencies from collapsing.

DEBUG6=debug6_level

Level of debugging for OMPROUTE to use for IPv6 routing protocols. The following values are valid :

DEBUG=0 turns off OMPROUTE IPv4 and initialization debugging.
DEBUG=1 provides internal debug messages.
DEBUG=2 provides the same information as DEBUG=1 plus hexadecimal packet tracing.
DEBUG=3 provides the same information as DEBUG=2 plus module entry and exit.
DEBUG=4 provides the same information as DEBUG=3 plus task add and run.

SADEBUG=sadebug_level

Level of debugging for OMPROUTE subagent to use.

OSPF

Specifies that OSPF information is to be displayed.

LIST

Specifies that OSPF information is to be displayed as defined in the OMPROUTE configuration file.

ALL: Displays a comprehensive list of all configuration information.
AREAS: Displays all information concerning configured OSPF areas and their associated ranges.
InterFaceS: Displays, for each OSPF interface, the IP address and configured parameters as coded in the OMPROUTE configuration file.
NBMA: Displays the interface address and polling interval related to interfaces connected to non-broadcast multi-access networks.
NeighBoRS: Displays the configured neighbors on non-broadcast networks.
VLINKS: Displays all virtual links that have been configured with this router as the endpoint.

LSA

Displays the contents of a single link state advertisement contained in the OSPF database.

A link state advertisement is defined by its

Link state type (LSTYPE=ls_type)
Link state ID (LSID=lsid)
Advertising router (ORIGinator=ad_router).

There is a separate link state database for each OSPF area. AREAID=area_id on the command line tells the software which database you want to search. The different kinds of advertisements, which depend on the value given for link-state-type, are:

Router links (LSTYPE=1): Describe the collected states of a router interface attached to a router.
Network links (LSTYPE=2): Describe the set of routers attached to a network.
Summary link, IP network (LSTYPE=3): Describe interarea routes to networks.
Summary link, ASBR (LSTYPE=4): Describe interarea routes to AS boundary routers.
AS external link (LSTYPE=5): Describe routes to destinations external to the Autonomous System.

Note: The ORIGINATOR needs to be specified only for link-state-types three, four, and five. The AREAID value needs to be specified for all link-state-types except five.

Link State IDs, originators (specified by their router IDs), and area IDs take the same format as IP addresses. For example, the backbone area can be entered as 0.0.0.0

AREASUM

Displays the statistics and parameters for all OSPF areas attached to the router.

EXTERNAL

Displays the AS external advertisements belonging to the OSPF routing domain. One line is printed for each advertisement.

DATABASE,AREAID=area_id

Displays a description of the contents of a particular OSPF area link state database. AS external advertisements are omitted from the display. A single line is printed for each advertisement. If AREAID is not specified, the database from area 0.0.0.0 will be displayed.

DBSIZE

Displays the number of LSAs currently in the link state database, categorized by type

InterFace,NAME=if_name

Displays current, run-time statistics and parameters related to OSPF interfaces. If a NAME=if_name parameter is omitted, a single line is printed summarizing each interface. If a NAME=if_name parameter is specified, detailed statistics for that interface will be displayed.

ACTIVATE: Activate an OSPF interface that is in suspend state to allow adjacency formations with neighbors over this interface. This parameter is not applicable for static and dynamic VIPA interfaces. If this is a LAN interface and there is another alternate redundant interface on this same LAN segment that is the primary OSPF interface, this interface becomes a backup interface. This command does not force the activated interface to take over or resume the primary OSPF interface role for the LAN segment.
SUSPEND: Suspend an active OSPF interface that is not in DOWN or SUSPEND state so that adjacency formations with neighbors over this interface are stopped or not allowed. This forces adjacency attempts with neighbors over an alternate redundant interface if this is a LAN interface and an alternate interface is available. Existing connections that use static routes over the suspended interface are not disrupted. This parameter is not applicable for static and dynamic VIPA interfaces. If a TCP/IP stack is recycled while an interface is in suspended state, the interface state is reset after the recycle.

NeighBoR,IPADDR=ip_addr

Displays the statistics and parameters related to OSPF neighbors. If an IPADDR=ip_addr parameter is omitted, a single line is printed summarizing each neighbor. If an IPADDR=ip_addr parameter is given, detailed statistics for that neighbor are displayed.

ROUTERS

Displays all routes to other routers that have been calculated by OSPF and are currently present in the routing table.

STATiStics

Displays statistics generated by the OSPF routing protocol. The statistics indicate how well the implementation is performing, including its memory and network utilization. Many of the fields displayed are confirmation of the OSPF configuration.

WEIGHT

Dynamically change the cost of an OSPF interface. This new cost is flooded quickly throughout the OSPF routing domain, and modifies the routing immediately.

The cost of the interface reverts to its configured value whenever OMPROUTE is restarted. To make the cost change permanent, you must reconfigure the appropriate OSPF interface in the configuration file. This command can be issued only for an OSPF interface that is active in the TCP/IP stack.

NAME=name: Name of the OSPF interface the new cost affects.
COST=cost: New cost value for the OSPF interface.

RIP

Specifies that RIP information is to be displayed.

LIST

Specifies that RIP information is to be displayed as defined in the OMPROUTE configuration file.

ALL: Display all RIP-related configuration information.
InterFaceS: Display IP addresses and configured parameters for each RIP interface.
ACCEPTED: Displays the routes to be unconditionally accepted, as configured with the ACCEPT_RIP_ROUTE statement.

InterFace,NAME=if_name

Displays statistics and parameters related to RIP interfaces. If a NAME=if_name parameter is omitted, a single line is printed summarizing each interface. If a NAME=if_name parameter is given, detailed statistics for the specified interface (if_name) are displayed.

FILTERS

Displays the Global RIP filters.

GENERIC

Specifies that IPv4 information not related to a specific routing protocol is to be displayed.

LIST

Specifies that information is to be displayed as defined in the OMPROUTE configuration file.

ALL: Displays all IPv4 information that is not related to a specific routing protocol.
InterFaceS: Lists all generic IPv4 interfaces that are defined to OMPROUTE using INTERFACE statements.

InterFace

Displays statistics and parameters related to IPv4 generic interfaces that are known to TCP/IP.

RTTABLE

Displays routes in an OMPROUTE IPv4 routing table. If this option is used without the PRtable option, the routes that are displayed are from the main routing table.

DEST=ip_addr: Displays the routes to a particular destination. When multiple equal-cost routes exist, use this option to obtain a list of the next hops. You cannot use this option with the DELETED option.
PRtable=ALL: Displays routes in all of the OMPROUTE IPv4 policy-based routing tables. The dynamic routing parameters configured to the Policy Agent for a table are displayed following the routes for the table.
PRtable=prname: Displays routes in the specified OMPROUTE IPv4 policy-based routing table. The dynamic routing parameters configured to the Policy Agent for the table are displayed following the routes for the table.
DELETED: Displays information about routes that have been deleted from the OMPROUTE routing table and that have not been replaced. You cannot use this option with the DEST=ip_addr option.

Results:

If the RIP protocol is running, deleted routes are displayable for only 3 minutes after deletion. After 3 minutes have elapsed they are garbage collected by RIP and are no longer displayable.
If a policy-based routing table is configured to the Policy Agent with no IPv4 dynamic routing parameters, OMPROUTE has no knowledge of that routing table for IPv4. The routing table does not appear in the display of OMPROUTE IPv4 routing tables. The routing table does not appear in the display of OMPROUTE routing tables.
Only active policy-based routing tables appear in the display of OMPROUTE routing tables. A policy-based routing table is active if it is referenced by an active routing rule and its associated action.
This option displays the contents of the working tables that are used by OMPROUTE; it does not display the TCP/IP routing tables. The OMPROUTE routing tables might contain information that is different from the information in the TCP/IP routing tables. For more information about displaying the contents of the TCP/IP routing tables, see DISPLAY TCPIP,,NETSTAT.

IPV6OSPF

Specifies that IPv6 OSPF information is to be displayed.

ALL

Displays a comprehensive list of IPv6 OSPF information.

AREASUM

Displays the statistics and parameters for all IPv6 OSPF areas attached to the router.

InterFace,NAME=if_name or InterFace,ID=if_id

Displays current, run-time statistics and parameters related to IPv6 OSPF interfaces. If the NAME= and ID= parameters are omitted, a single line is printed summarizing each interface. If the NAME= or ID= parameter is specified, detailed statistics for that interface will be displayed.

VLINK,ENDPT=router-id

Displays current, run-time statistics and parameters related to IPv6 OSPF virtual links. If the ENDPT= parameter is omitted, a single line is printed summarizing each virtual link. If the ENDPT= parameter is specified, detailed statistics for that virtual link will be displayed.

NeighBoR,ID=router-id,IFNAME=if_name

Displays the statistics and parameters related to IPv6 OSPF neighbors.

If the ID= parameter is omitted, a single line is printed summarizing each neighbor.
If the ID= parameter is given, detailed statistics for that neighbor are displayed.
If the neighbor specified by the ID= parameter has more than one neighbor relationship with OMPROUTE (for example if there are multiple IPv6 OSPF links connecting them), the IFNAME= parameter can be used to specify which link's adjacency to examine (for an adjacency over a virtual link, specify IFNAME=*).

DBSIZE

Displays the number of LSAs currently in the IPv6 OSPF link state database, categorized by type.

LSA

Displays the contents of a single link state advertisement contained in the IPv6 OSPF database. A link state advertisement is defined by its:

Link state type (LSTYPE=ls_type, where ls_type is one of the hexadecimal link state type values listed below).
Link state ID (LSID=lsid).
Advertising router (ORIGinator=ad_router).

Each interface has its own set of link LSAs (LSTYPE=0008). IFNAME=interface_name on the command line indicates which link's LSA you want to display.

There is also a separate link state database for each IPv6 OSPF area. AREAID=area_id on the command line indicates which database you want to search. If you do not specify which area to search, the backbone (0.0.0.0) area will be searched. The different kinds of advertisements, which depend on the value given for link state type, are:

Router LSA (LSTYPE=2001): The complete collection describes the state and cost of the router's interfaces to the area. Each router in an area originates one or more Router LSAs.
Network LSA (LSTYPE=2002): Originated by the Designated Router of each multiaccess link (i.e., LAN) in the area which supports two or more routers. Describes the set of routers attached to the link, including the Designated Router.
Inter-Area Prefix LSA (LSTYPE=2003): Originated by an area border router. Describes the route to an IPv6 address prefix that belongs to another area.
Inter-Area Router LSA (LSTYPE=2004): Originated by an area border router. Describes the route to an AS boundary router that belongs to another area.
AS External LSA (LSTYPE=4005): Originated by an AS boundary router. Describes the route to a destination external to the IPv6 OSPF Autonomous System.
Link LSA (LSTYPE=0008): Originated by routers for each link to which they are attached. Provides the router's link-local address, provides a list of IPv6 address prefixes for the link, and asserts a set of options for the Network LSA that will be originated for the link.
Intra-Area Prefix LSA (LSTYPE=2009): Originated by routers to advertise one or more IPv6 address prefixes that are associated with the router itself, an attached stub network segment, or an attached transit network segment.

Requirements:

Specify the AREAID value for all link state types except AS External LSA.
Note: The AREAID value defaults to the backbone (0.0.0.0) area if not specified.
Specify the IFNAME value for Link LSAs (LSTYPE=0008).
Originators (specified by their router IDs) and area IDs are specified in dotted-decimal format. For example, the backbone area is entered as 0.0.0.0.

EXTERNAL

Displays the AS external LSAs belonging to the IPv6 OSPF routing domain. One line is printed for each advertisement.

DATABASE,AREAID=area_id

Displays the contents of a particular IPv6 OSPF area link state database. AS external advertisements are omitted from the display. A single line is printed for each advertisement. If AREAID is not specified, the database from area 0.0.0.0 will be displayed.

ROUTERS

Displays all routes to other routers that have been calculated by IPv6 OSPF and are currently present in the routing table.

STATISTICS

Displays statistics generated by the IPv6 OSPF routing protocol. The statistics indicate how well the implementation is performing, including its memory and network utilization.

WEIGHT

Dynamically change the cost of an IPv6 OSPF interface. This new cost is flooded quickly throughout the IPv6 OSPF routing domain, and modifies the routing immediately. The cost of the interface reverts to its configured value whenever OMPROUTE is restarted. To make the cost change permanent, you must reconfigure the appropriate IPv6 OSPF interface in the OMPROUTE configuration file.

NAME=name: Name of the IPv6 OSPF interface the new cost affects.
COST=cost: New cost value for the IPv6 OSPF interface.

IPV6RIP

Specifies the IPv6 RIP information.

ALL: Displays all IPv6 RIP-related information.
ACCEPTED: Displays the routes to be unconditionally accepted, as configured with the IPV6_ACCEPT_RIP_ROUTE statement.
InterFace,NAME=if_name: Displays statistics and parameters related to IPv6 RIP interfaces. If the NAME=if_name parameter is omitted, a single line is printed summarizing each interface. If the NAME=if_name parameter is given, detailed statistics for the specified interface (if_name) are displayed.
FILTERS: Displays the Global IPv6 RIP filters.

GENERIC6

Specifies IPv6 information not related to a specific dynamic routing protocol.

ALL: Displays all IPv6 information not related to a specific routing protocol.
InterFace,NAME=if_name: Displays statistics and parameters related to IPv6 generic interfaces that are known to TCP/IP or defined to OMPROUTE with IPV6_INTERFACE statements. If the NAME=if_name parameter is omitted, a single line is printed summarizing each interface. If the NAME=if_name parameter is given, detailed statistics for the specified interface (if_name) is displayed.

RT6TABLE

Displays routes in an OMPROUTE IPv6 routing table. If this option is used without the PRtable option, the routes that are displayed are from the main routing table.

DEST=ip_addr/prefixlen: Displays information about a particular route. When multiple equal-cost routes exist, use this option to obtain a list of the next hops. You cannot use this option with the DELETED option.
PRtable=ALL: Displays routes in all of the OMPROUTE IPv6 policy-based routing tables. The dynamic routing parameters that are configured to the policy agent for a table are displayed following the routes for the table.
PRtable=prname: Displays routes in the specified OMPROUTE IPv6 policy-based routing table. The dynamic routing parameters that are configured to the policy agent for the table are displayed following the routes for the table.
DELETED: Displays information about IPv6 routes that have been deleted from the OMPROUTE routing table and that have not been replaced. You cannot use this option with the DEST=ip_addr/prefixlen option.

Results:

If the RIP protocol is running, deleted routes are displayable for only 3 minutes after they are deleted. After 3 minutes have elapsed they are garbage collected by RIP and are no longer displayable.
If a policy-based routing table is configured to the policy agent with no IPv6 dynamic routing parameters, OMPROUTE has no knowledge of that routing table for IPv6. The routing table is not included in the display of OMPROUTE IPv6 routing tables.
Only active policy-based routing tables are included in the display of OMPROUTE routing tables. A policy-based routing table is active if an active routing rule and its associated action reference the routing table.
This option displays the contents of the working tables that are used by OMPROUTE; it does not display the TCP/IP routing tables. The OMPROUTE routing tables might contain information that is different from the information in the TCP/IP routing tables. For more information about displaying the contents of the TCP/IP routing tables, see DISPLAY TCPIP,,NETSTAT.

Examples

You can use MODIFY OMPROUTE commands to perform the following functions: