Netsh Routing IP RIP Context Commands
Applies To: Windows Server 2008, Windows Server 2008 R2
The following commands are specific to the routing IP rip context within the Netsh environment.
dump
install
uninstall
Add commands
add acceptfilter
add announcefilter
add interface
add neighbor
add peerfilter
Delete commands
delete acceptfilter
delete announcefilter
delete interface
delete neighbor
delete peerfilter
Set commands
set flags
set global
set interface
Show commands
show flags
show global
show globalstats
show ifbinding
show ifstats
show interface
show neighbor
Netsh commands for routing IP RIP
The following entries provide details for each command.
dump
Displays the Routing Information Protocol (RIP) configuration of a remote access server in script form.
Syntax
dump
Remarks
- You can dump the contents of the current configuration to a file that can be used to restore altered configuration settings.
Example
The following commands save the current configuration as a script in the c:\test\ripcfg.dmp file.
From the command prompt:
netsh routing ip rip dump > c:\test\ripcfg.dmp
From the netsh routing ip rip context prompt:
set file open c:\test\ripcfg.dmp
dump
set file close
You can use the netsh exec command to run the script created by the netsh dump command.
install
Installs the RIP protocol for IPv4.
Syntax
install
uninstall
Uninstalls the RIP protocol for IPv4.
Syntax
uninstall
add peerfilter
Adds a filter for routers that are accepted as peers.
Syntax
add peerfilter
[ server = ] IPAddress
Parameters
- [ server = ] IPAddress
Required. Specifies, by IPv4 address, the peer router whose traffic you want to accept.
Example
To add a server with IP 10.0.0.2 to the list of RIP routers from which announcements will be processed, type:
add peerfilter server=10.0.0.2
add acceptfilter
Adds an acceptance filter for routes received on an interface.
Syntax
add acceptfilter
[ name = ] InterfaceName
[ addr = ] IPAddress1 IPAddress2
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, an interface where RIP is available for use. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ addr = ] IPAddress1 IPAddress2
Required. Specifies a pair of IPv4 addresses. The first address is for the low IP address; the second address is for the high IP address, which will be used to build the filter.
Example
To add an acceptance filter for the “Local Area Connection” interface for an IP range of 10.0.0.2 to 11.1.1.2, type:
add acceptfilter name="Local Area Connection" 10.0.0.2 11.1.1.2
add announcefilter
Adds a filter for routes announced on an interface.
Syntax
add announcefilter
[ name = ] InterfaceName
[ addr = ] IPAddress1 IPAddress2
Parameters
- [ name = ] InterfaceName
Required. Specifies the name of an interface where RIP is available for use. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ addr = ] IPAddress1 IPAddress2
Required. Specifies a pair of IPv4 addresses. The first address is for the low IP address; the second address is for the high IP address, which will be used to build the filter.
Example
To add a filter for routes announced on the “Local Area Connection” interface for a range of IP addresses from 10.0.0.2 to 11.1.1.2, type:
add announcefilter name="Local Area Connection" 10.0.0.2 11.1.1.2
add neighbor
Adds a RIP neighbor on an interface.
Syntax
add neighbor
[ name = ] InterfaceName
[ addr = ] IPAddress
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, an interface where RIP is available for use. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ addr = ] IPAddress
Required. Specifies the IPv4 address of the RIP neighbor you want to add.
Example
To add a RIP neighbor located at an IPv4 address of 10.0.0.2 for the “Local Area Connection” interface, type:
add neighbor "Local Area Connection" 10.0.0.2
add interface
Adds RIP to a specified interface.
Syntax
add interface
[ name = ] InterfaceName
[ [ metric = ] Integer ]
[ [ update = ] Integer]
[ [ announce = ] { none | rip1 | rip1compat | rip2 } ]
[ [ accept = ] { none | rip1 | rip1compat | rip2 } ]
[ [ expire = ] Integer ]
[ [ remove = ] Integer ]
[ [ updatemode = ] { demand | periodic } ]
[ [ authmode = ] { authnone | authsimplepassword } ]
[ [ tag = ] Integer ]
[ [ unicast = ] { also | only | disable } ]
[ [ accfiltmode = ] { include | exclude | disable } ]
[ [ annfiltmode = ] { include | exclude | disable } ]
[ [ password = ] Password ]
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, the interface on which to add RIP. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ metric = ] Integer ]
Specifies a metric value for routes based on this interface.
- [ update = ] Integer
Specifies, in seconds, the full update interval.
[ announce = ] { none | rip1 | rip1compat | rip2 }
Specifies which routes should be announced.none specifies that all routes should be announced.
rip1 specifies that only RIP version 1 routes should be announced.
rip1compat specifies that announcements should be made in RIP version-compatible mode.
rip2 parameter that only RIP version 2 routes should be announced.
[ accept = ] { none | rip1 | rip1compat | rip2 }
Specifies which routes should be accepted.none specifies that all routes should be accepted.
rip1 specifies that only RIP version 1 routes should be accepted.
rip1compat specifies that routes should be accepted in RIP version-compatible mode.
rip2 specifies that only RIP version 2 routes should be accepted.
- [ expire = ] Integer
Specifies, in seconds, the route expiration interval.
- [ remove = ] Integer
Specifies, in seconds, the route removal interval.
[ updatemode = ] { demand | periodic }
Specifies when updates will occur.demand specifies that updates should occur on demand.
periodic specifies that updates should occur at regular intervals.
[ authMode = ] { authnone | authsimplepassword }
Specifies whether authorization should be required.authnone specifies that no authorization should be required.
authsimplepassword specifies that password authorization should be required.
- [ tag = ] Integer
Specifies the route tag.
[ unicast = ] { also | only | disable }
Specifies the unicast mode.also specifies use also unicast mode.
only specifies use only unicast mode.
disable specifies that unicast mode should be disabled.
[ accfiltmode = ] { include | exclude | disable }
Specifies whether acceptance filters should be included or disabled.include specifies that acceptance filters should be included.
exclude specifies that acceptance filters should not be included.
disable specifies that acceptance filters should be disabled.
[ annfiltmode = ] { include | exclude | disable }
Specifies whether announcement filters should be included or disabled.include specifies that announcement filters should be included.
exclude specifies that announcement filters should not be included.
disable specifies that announcement filters should be disabled.
- [ password = ] Password
Specifies a plaintext password no longer than 16 characters.
Example
To enable and configure RIP on the interface named Local Area Connection using RIP configuration default settings, type:
add interface "Local Area Connection"
delete peerfilter
Deletes a filter for an accepted peer server.
Syntax
delete peerfilter
[ server = ] IPAddress
Parameters
- [ server = ] IPAddress
Required. Specifies, by IPv4 address, the peer server whose traffic you do not want to filter.
Example
To remove a server with an IPv4 address of 10.0.0.2 from the list of RIP routers from which announcements will be processed, type:
delete peerfilter server=10.0.0.2
delete acceptfilter
Deletes an acceptance filter for routes received on a specified interface.
Syntax
delete acceptfilter
[ name = ] InterfaceName
[ addr = ] IPAddress1 IPAddress2
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, an interface where RIP is available for use. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ addr = ] IPAddress1 IPAddress2
Required. Specifies a pair of IPv4 addresses. The first address is for the low IP address; the second address is for the high IP address.
Example
To delete an acceptance filter for the IP ranges of 10.0.0.2 to 11.1.1.2 on an interface named Local Area Connection, type:
delete acceptfilter "Local Area Connection" 10.0.0.2 11.1.1.2
delete announcefilter
Deletes an announcement filter set for an interface.
Syntax
delete announcefilter
[ name = ] InterfaceName
[ addr = ] IPAddress1 IPAddress2
Parameters
- [ name = ] InterfaceName
Required. Specifies the name of an interface where RIP is available for use. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ addr = ] IPAddress1 IPAddress2
Required. Specifies a pair of IPv4 addresses. The first address specifies the low IP address; the second address specifies the high IP address.
Example
To delete an announcement filter for the IP range 10.0.0.2 to 11.1.1.2 for an interface named Local Area Connection, type:
delete announcefilter "Local Area Connection" 10.0.0.2 11.1.1.2
delete neighbor
Deletes a RIP neighbor from an interface.
Syntax
delete neighbor
[ name = ] InterfaceName
[ addr = ] IPAddress
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, an interface where RIP is available for use. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ addr = ] IPAddress
Required. Specifies, by IPv4 address, the RIP neighbor to delete.
Example
To delete a RIP neighbor located at 10.0.0.2 for the “Local Area Connection” interface, type:
delete neighbor name="Local Area Connection" 10.0.0.2
delete interface
Removes RIP from the specified interface.
Syntax
delete interface
[ name = ] InterfaceName
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, an interface from which you want to remove RIP. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
Example
To remove RIP from the “Local Area Connection” interface, type:
delete interface "Local Area Connection"
set interface
Configures RIP on a specified interface.
Syntax
set interface
[ name = ] InterfaceName
[ [ metric = ] Integer ]
[ [ update = ] Integer]
[ [ announce = ] { none | rip1 | rip1compat | rip2 } ]
[ [ accept = ] { none | rip1 | rip1compat | rip2 } ]
[ [ expire = ] Integer ]
[ [ remove = ] Integer ]
[ [ updatemode = ] { demand | periodic } ]
[ [ authmode = ] { authnone | authsimplepassword } ]
[ [ tag = ] Integer ]
[ [ unicast = ] { also | only | disable } ]
[ [ accfiltmode = ] { include | exclude | disable } ]
[ [ annfiltmode = ] { include | exclude | disable } ]
[ [ password = ] Password ]
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, the interface on which to configure RIP. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
- [ metric = ] Integer ]
Specifies a metric value for routes based on this interface.
- [ update = ] Integer
Specifies, in seconds, the full update interval.
[ announce = ] { none | rip1 | rip1compat | rip2 }
Specifies which routes should be announced.none specifies that all routes should be announced.
rip1 specifies that only RIP version 1 routes should be announced.
rip1compat specifies that announcements should be made in RIP version-compatible mode.
rip2 parameter that only RIP version 2 routes should be announced.
[ accept = ] { none | rip1 | rip1compat | rip2 }
Specifies which routes should be accepted.none specifies that all routes should be accepted.
rip1 specifies that only RIP version 1 routes should be accepted.
rip1compat specifies that routes should be accepted in RIP version-compatible mode.
rip2 specifies that only RIP version 2 routes should be accepted.
- [ expire = ] Integer
Specifies, in seconds, the route expiration interval.
- [ remove = ] Integer
Specifies, in seconds, the route removal interval.
[ updatemode = ] { demand | periodic }
Specifies when updates will occur.demand specifies that updates should occur on demand.
periodic specifies that updates should occur at regular intervals.
[ authMode = ] { authnone | authsimplepassword }
Specifies whether authorization should be required.authnone specifies that no authorization should be required.
authsimplepassword specifies that password authorization should be required.
- [ tag = ] Integer
Specifies the route tag.
[ unicast = ] { also | only | disable }
Specifies the unicast mode.also specifies use also unicast mode.
only specifies use only unicast mode.
disable specifies that unicast mode should be disabled.
[ accfiltmode = ] { include | exclude | disable }
Specifies whether acceptance filters should be included or disabled.include specifies that acceptance filters should be included.
exclude specifies that acceptance filters should not be included.
disable specifies that acceptance filters should be disabled.
[ annfiltmode = ] { include | exclude | disable }
Specifies whether announcement filters should be included or disabled.include specifies that announcement filters should be included.
exclude specifies that announcement filters should not be included.
disable specifies that announcement filters should be disabled.
- [ password = ] Password
Specifies a plaintext password no longer than 16 characters.
Example
To modify the RIP configuration on the “Local Area Connection” interface, specifying a metric value of 2 and that updates should occur on demand, type:
set interface name="Local Area Connection" metric=2 updatemode=periodic
set flags
Sets RIP-related flags for a specified interface.
Syntax
set flags
[ name = ] InterfaceName
[ flag = ]
[ clear ]
[ splithorizon ]
[ poisonreverse ]
[ triggeredupdates ]
[ cleanupupdates ]
[ accepthostroutes ]
[ acceptdefaultroutes ]
[ senddefaultroutes ]
[ nosubnetsummary ]
Parameters
- [ name = ] InterfaceName
Required. Specifies, by name, the interface on which to set flags. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
[ flag = ] [ clear ] [ splithorizon ] [ poisonreverse ] [ triggeredupdates ] [ cleanupupdates ] [ accepthostroutes ] [ acceptdefaultroutes ] [ senddefaultroutes ] [ sendhostroutes ] [ nosubnetsummary ]
Specifies policies for RIP-related flags.clear specifies that all set RIP flags should be cleared.
splithorizon specifies that RIP for split horizon should be enabled.
poisonreverse specifies that RIP for poison reverse should be enabled.
triggeredupdates specifies that RIP triggered updates should occur.
cleanupupdates specifies that cleanup updates for RIP should occur.
accepthostroutes specifies that host routes should be accepted.
acceptdefaultroutes specifies that default routes should be accepted.
senddefaultroutes specifies that default routes should be sent.
sendhostroutes specifies that host routes should be sent.
nosubnetsummary specifies that subnet summarization should not occur.
Remarks
- Multiple flag values can be specified in a comma separated list.
Example
To set RIP-related flags for the “Local Area Connection” interface, type:
set flags name="Local Area Connection" splithorizon,accepthostroutes
set global
Sets global RIP parameters.
Syntax
set global
[ [ loglevel = ] { none | error | warn | info } ]
[ [ mintrig = ] Integer ]
[ [ peermode = ] { include | exclude | disable } ]
Parameters
[loglevel = ] { none | error | warn | info }
Specifies which RIP events should be logged.none specifies that no RIP events should be logged.
error specifies that only errors related to RIP should be logged.
warn specifies that both errors and warnings related to RIP should be logged.
info specifies that all events related to RIP should be logged.
- [ mintrig = ] Integer
Specifies, in minutes, the minimum amount of time that should elapse between triggers.
[ peermode = ] { include | exclude | disable }
Specifies whether peers should be included and whether peer mode should be disabled.include specifies that peers should be included.
exclude specifies that peers should not be included.
disable specifies that peer mode should be disabled.
Example
To configure global RIP parameters to specify no RIP event logging, 10 minutes between triggers, and with peer mode disabled, type:
set global none 10 disable
show interface
Shows RIP configuration for the specified interface. Used without parameters, show interface displays configuration information for all interfaces.
Syntax
show interface
[ [ name = ] InterfaceName ]
Parameters
- [ [ name = ] InterfaceName ]
Specifies, by name, the interface whose information you want to display. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
show flags
Displays RIP flags set for a specified interface. Used without parameters, show flags displays information for all interfaces.
Syntax
show flags
[ [ name = ] InterfaceName ]
Parameters
- [ [ name = ] InterfaceName ]
Specifies, by name, the interface for which you want to display information. The InterfaceName parameter must match the name of the interface as specified in Network Connections. If InterfaceName contains spaces, use quotation marks around the text (for example, "Interface Name").
show global
Shows RIP global parameters.
Syntax
show global
show ifstats
Displays RIP statistics for a specified interface. Used without parameters, show ifstats displays information once for all interfaces.
Syntax
show ifstats
[ [ index = ] Integer ]
[ [ rr = ] Integer ]
Parameters
- [ index = ] Integer
Specifies, by index number, the interface for which you want to display information.
- [ rr = ] Integer
Specifies, in seconds, how often you want the information to be refreshed.
Remarks
- To list the index value for each interface, use the show interface command in the netsh interface ipv4 context.
Example
To display RIP statistics every 5 seconds for an interface with an index value of 1, type:
show ifstats index=1 rr=5
show ifbinding
Displays RIP interface IPv4 address binding. Used without parameters, show ifbinding displays information once for all interfaces.
Syntax
show ifbinding
[ [ index = ] Integer ]
[ [ rr = ] Integer ]
Parameters
- [ index = ] Integer
Specifies, by index number, the interface for which you want to display information.
- [ rr = ] Integer ]
Specifies, in seconds, how often you want the information to be refreshed.
Remarks
- To list the index value for each interface, use the netsh interface ipv4 show interface or netsh interface ipv6 show interface commands.
Example
To display the bindings every 5 seconds for an interface with an index value of 1, type:
show ifbinding index=1 rr=5
show globalstats
Displays RIP global statistics.
Syntax
show globalstats
[ [ rr = ] Integer ]
Parameters
- [ rr = ] Integer
Specifies, in seconds, how often you want the information to be refreshed.
Example
To display RIP global statistics which refreshes at the rate of every 5 seconds, type:
show globalstats rr=5
show neighbor
Displays RIP peer statistics.
Syntax
show neighbor
[ [ index = ] Integer ]
[ [ rr = ] Integer ]
Parameters
- [ index = ] Integer
Specifies, by index number, the interface for which you want to display information.
- [ rr = ] Integer
Specifies, in seconds, how often you want the information to be refreshed.
Remarks
- To list the index value for each interface, use the show interface command in the netsh interface ipv4 context.
Example
To display the bindings for IP address 10.0.0.1 at a refresh rate of every 5 seconds, type:
show neighbor index=1 rr=5