Cisco Nexus 5600 Series NX-OS Multicast Routing Command Reference
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- March 16, 2014
Chapter: I Commands
- ip mroute
- ip pim anycast-rp
- ip pim auto-rp
- ip pim auto-rp mapping-agent
- ip pim auto-rp mapping-agent-policy
- ip pim auto-rp rp-candidate
- ip pim auto-rp rp-candidate-policy
- ip pim bidir-rp-limit
- ip pim bidir-rp-limit
- ip pim border
- ip pim bsr bsr-policy
- ip pim bsr-candidate
- ip pim bsr forward
- ip pim bsr listen
- ip pim bsr rp-candidate-policy
- ip pim dr-priority
- ip pim event-history
- ip pim flush-routes
- ip pim hello-authentication ah-md5
- ip pim hello-interval
- ip pim jp-policy
- ip pim log-neighbor-changes
- ip pim neighbor-policy
- ip pim pre-build-spt
- ip pim register-policy
- ip pim register-rate-limit
- ip pim rp-address
- ip pim rp-candidate
- ip pim send-rp-announce
- ip pim send-rp-discovery
- ip pim sg-expiry-timer
- ip pim sparse-mode
- ip pim spt-threshold infinity
- ip pim ssm policy
- ip pim ssm
- ip pim state-limit
- ip pim use-shared-tree-only
- ip routing multicast event-history
- ip routing multicast holddown
- ip routing multicast software-replicate
- ipv6 pim anycast-rp
- ipv6 pim bidir-rp-limit
- ipv6 pim border
- ipv6 pim bsr bsr-policy
- ipv6 pim bsr-candidate
- ipv6 pim bsr forward
- ipv6 pim bsr listen
- ipv6 pim bsr rp-candidate-policy
- ipv6 pim dr-priority
- ipv6 pim event-history
- ipv6 pim flush-routes
- ipv6 pim hello-interval
- ipv6 pim jp-policy
- ipv6 pim log-neighbor-changes
- ipv6 pim neighbor-policy
- ipv6 pim register-policy
- ipv6 pim register-rate-limit
- ipv6 pim rp-address
- ipv6 pim rp-candidate
- ipv6 pim sparse-mode
- ipv6 pim ssm range
- ipv6 pim state-limit
- ipv6 pim use-shared-tree-only
I Commands
This chapter describes the Cisco NX-OS PIM commands that begin with I.
ip mroute
To configure multicast reverse path forwarding (RPF) static routes, use the ip mroute command. To remove RPF static routes, use the no form of this command.
ip mroute { ip-addr ip-mask | ip-prefix } {{ next-hop | nh-prefix } | { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } } [ pref ] [ vrf vrf-name ]
no ip mroute { ip-addr ip-mask | ip-prefix } {{ next-hop | nh-prefix } | { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } } [ pref ] [ vrf vrf-name ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an RPF static route:
This example shows how to remove an RPF static route:
Related Commands
|
|
|
|---|---|
ip pim anycast-rp
To configure an IPv4 Protocol Independent Multicast (PIM) Anycast-RP peer for the specified Anycast-RP address, use the ip pim anycast-rp command. To remove the peer, use the no form of this command.
ip pim anycast-rp anycast-rp rp-addr
no ip pim anycast-rp anycast-rp rp-addr
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Each command with the same Anycast-RP address forms an Anycast-RP set. The IP addresses of RPs are used for communication with RPs in the set.
Examples
This example shows how to configure a PIM Anycast-RP peer:
switch# configure terminal
switch(config)# ip pim anycast-rp 192.0.2.3 192.0.2.31
This example shows how to remove a peer:
switch# configure terminal
switch(config)# no ip pim anycast-rp 192.0.2.3 192.0.2.31
Related Commands
|
|
|
|---|---|
ip pim auto-rp
To enable Protocol Independent Multicast (PIM) listening and forwarding of Auto-RP messages, use the ip pim auto-rp listen and ip pim auto-rp forward commands. To disable the listening and forwarding of Auto-RP messages, use the no form of this command.
ip pim auto-rp { listen [ forward ] | forward [ listen ]}
no ip pim auto-rp [{ listen [ forward ] | forward [ listen ]}]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable listening and forwarding of Auto-RP messages:
switch(config)# ip pim auto-rp listen forward
This example shows how to disable listening and forwarding of Auto-RP messages:
switch(config)# no ip pim auto-rp listen forward
Related Commands
|
|
|
|---|---|
ip pim auto-rp mapping-agent
To configure the router as an IPv4 Protocol Independent Multicast (PIM) Auto-RP mapping agent that sends RP-Discovery messages, use the ip pim auto-rp mapping-agent command. To remove the mapping agent configuration, use the no form of this command.
ip pim auto-rp mapping-agent { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } [ scope ttl ]
no ip pim auto-rp mapping-agent [ { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } ] [ scope ttl ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The ip pim send-rp-discovery command is an alternative form of this command.
Examples
This example shows how to configure an Auto-RP mapping agent:
switch(config)# ip pim auto-rp mapping-agent ethernet 2/1
This example shows how to remove the Auto-RP mapping agent configuration:
switch(config)# no ip pim auto-rp mapping-agent ethernet 2/1
Related Commands
|
|
|
|---|---|
ip pim auto-rp mapping-agent-policy
To enable filtering of IPv4 IPv4 Protocol Independent Multicast (PIM) Auto-RP Discover messages, use the ip pim auto-rp mapping-agent-policy command. To disable filtering, use the no form of this command.
ip pim auto-rp mapping-agent-policy policy-name
no ip pim auto-rp mapping-agent-policy [ policy-name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
This command can be used on client routers where you can specify mapping agent addresses.
You can specify mapping agent source addresses to filter messages from with the match ip multicast command in a route-map policy.
Examples
This example shows how to enable a route-map policy to filter Auto-RP Discover messages:
switch(config)# ip pim auto-rp mapping-agent-policy my_mapping_agent_policy
This example shows how to disable filtering:
switch(config)# no ip pim auto-rp mapping-agent-policy
Related Commands
|
|
|
|---|---|
ip pim auto-rp rp-candidate
To configure an IPv4 Protocol Independent Multicast (PIM) Auto-RP candidate route processor (RP), use the ip pim auto-rp rp-candidate command. To remove an Auto-RP candidate RP, use the no form of this command.
ip pim auto-rp rp-candidate { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } { group-list prefix } {[ scope ttl ] | [ interval interval ] | [ bidir ]}
no ip pim auto-rp rp-candidate [ { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } ] [ group-list prefix } {[ scope ttl ] | [ interval interval ] | [ bidir ]}
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The scope and interval, and bidir keywords can be entered once and in any order.
The ip pim send-rp-announce command is an alternative form of this command.
Using a route map, you can add group ranges that this auto RP candidate-RP can serve.
Note
Use the same configuration guidelines for the route-map auto-rp-range that you used when you create a route map for static RPS.
Examples
This example shows how to configure a PIM Auto-RP candidate RP:
switch(config)# ip pim auto-rp rp-candidate ethernet 2/1 group-list 239.0.0.0/24
This example shows how to remove a PIM Auto-RP candidate RP:
switch(config)# no ip pim auto-rp rp-candidate ethernet 2/1 group-list 239.0.0.0/24
Related Commands
|
|
|
|---|---|
ip pim auto-rp rp-candidate-policy
To allow the Auto-RP mapping agents to filter IPv4 Protocol Independent Multicast (PIM) Auto-RP Announce messages that are based on a route-map policy, use the ip pim auto-rp rp-candidate-policy command. To disable filtering, use the no form of this command.
ip pim auto-rp rp-candidate-policy policy-name
no ip pim auto-rp rp-candidate-policy [ policy-name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can specify the RP and group addresses, and whether the type is Bidir or ASM with the match ip multicast command in a route-map policy.
Examples
This example shows how to allow the Auto-RP mapping agents to filter Auto-RP Announce messages:
switch(config)# ip pim auto-rp rp-candidate-policy my_policy
This example shows how to disable filtering:
switch(config)# no ip pim auto-rp rp-candidate-policy
Related Commands
|
|
|
|---|---|
ip pim bidir-rp-limit
To configure the number of bidirectional (Bidir) RPs for use in IPv4 Protocol Independent Multicast (PIM), use the ip pim bidir-rp-limit command. To reset the number of RPs to the default, use the no form of this command.
no ip pim bidir-rp-limit limit
Syntax Description
Limit for the number of Bidir RPs permitted in PIM. The range is from 0 to 8. The default is 6. |
Defaults
Command Modes
Global configuration (config)
VRF configuration (config-vrf)
Command History
|
|
|
Usage Guidelines
Because the maximum ordinal count of designated forwarders (DFs) is 8, the PIM and IPv6 PIM RP limits should be no more than 8.
To display the Bidir RP limit configured, use this command line:
switch(config)# show running-config | include bidir
Examples
This example shows how to configure the number of Bidir RPs:
switch(config)# ip pim bidir-rp-limit 6
This example shows how to reset the number of Bidir RPs to the default:
switch(config)# no ip pim bidir-rp-limit 6
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ip pim bidir-rp-limit
To configure the number of bidirectional (Bidir) RPs for use in IPv4 Protocol Independent Multicast (PIM), use the ip pim bidir-rp-limit command. To reset the number of RPs to the default, use the no form of this command.
no ip pim bidir-rp-limit limit
Syntax Description
Limit for the number of Bidir RPs permitted in PIM. The range is from 0 to 8. The default is 6. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Because the maximum ordinal count of designated forwarders (DFs) is 8, the PIM and IPv6 PIM RP limits should be no more than 8.
To display the Bidir RP limit configured, use this command line:
switch(config)# show running-config | include bidir
Examples
This example shows how to configure the number of Bidir RPs:
switch(config)# ip pim bidir-rp-limit 6
This example shows how to reset the number of Bidir RPs to the default:
switch(config)# no ip pim bidir-rp-limit 6
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ip pim border
To configure an interface on an IPv4 Protocol Independent Multicast (PIM) border, use the ip pim border command. To remove an interface from a PIM border, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an interface on a PIM border:
switch(config)# ip pim border
This example shows how to remove an interface from a PIM border:
switch(config)# no ip pim border
Related Commands
|
|
|
|---|---|
ip pim bsr bsr-policy
To allow the bootstrap router (BSR) client routers to filter IPv4 Protocol Independent Multicast (PIM) BSR messages that are based on a route-map policy, use the ip pim bsr bsr-policy command. To disable filtering, use the no form of this command.
ip pim bsr bsr-policy policy-name
no ip pim bsr bsr-policy [ policy-name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can specify which source addresses to filter messages from with the match ip multicast command in a route-map policy.
Examples
This example shows how to allow the BSR client routers to filter BSR messages:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim bsr bsr-policy my_bsr_policy
This example shows how to disable filtering:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim bsr bsr-policy
Related Commands
|
|
|
|---|---|
ip pim bsr-candidate
To configure the router as an IPv4 Protocol Independent Multicast (PIM) bootstrap router (BSR) candidate, use the ip pim bsr-candidate command. To remove a router as a BSR candidate, use the no form of this command.
ip pim [ bsr ] bsr-candidate { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } [ hash-len hash-len ] [ priority priority ]
no ip pim [ bsr ] bsr-candidate [ { ethernet slot / port | loopback if_number | port-channel number | vlan vlan-id } ] [ hash-len hash-len ] [ priority priority ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The interface specified is used to derive the BSR source IP address used in BSR messages.
Examples
This example shows how to configure a router as a BSR candidate:
switch(config)# ip pim bsr-candidate ethernet 2/2
This example shows how to remove a router as a BSR candidate:
switch(config)# no ip pim bsr-candidate
Related Commands
|
|
|
|---|---|
ip pim bsr forward
To listen to and forward IPv4 Protocol Independent Multicast (PIM) bootstrap router (BSR) and Candidate-RP messages, use the ip pim bsr forward command. To disable listening and forwarding, use the no form of this command.
no ip pim bsr [ forward [ listen ]]
Syntax Description
(Optional) Specifies to listen to BSR and Candidate-RP messages. |
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
A router configured as either a candidate RP or a candidate BSR will automatically listen to and forward all BSR protocol messages, unless an interface is configured with the domain border feature.
The ip pim bsr listen command is an alternative form of this command.
Examples
This example shows how to forward BSR and Candidate-RP messages:
switch(config)# ip pim bsr forward
This example shows how to disable forwarding:
switch(config)# no ip pim bsr forward
Related Commands
|
|
|
|---|---|
ip pim bsr listen
To listen to and forward IPv4 Protocol Independent Multicast (PIM) bootstrap router (BSR) and Candidate-RP messages, use the ip pim bsr listen command. To disable listening and forwarding, use the no form of this command.
no ip pim bsr [ listen [ forward ]]
Syntax Description
(Optional) Specifies to forward BSR and Candidate-RP messages. |
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
A router configured as either a candidate RP or a candidate BSR will automatically listen to and forward all BSR protocol messages, unless an interface is configured with the domain border feature.
The ip pim bsr forward command is an alternative form of this command.
Examples
This example shows how to listen to and forward BSR and Candidate-RP messages:
switch(config)# ip pim bsr listen forward
This example shows how to disable listening and forwarding:
switch(config)# no ip pim bsr listen forward
Related Commands
|
|
|
|---|---|
ip pim bsr rp-candidate-policy
To filter IPv4 Protocol Independent Multicast (PIM) bootstrap router (BSR) Candidate-RP messages that are based on a route-map policy, use the ip pim bsr rp-candidate-policy command. To disable filtering, use the no form of this command.
ip pim bsr rp-candidate-policy policy-name
no ip pim bsr rp-candidate-policy [ policy-name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can specify the RP and group addresses, and whether the type is Bidir or ASM with the match ip multicast command in a route-map policy.
Examples
This example shows how to filter Candidate-RP messages:
switch(config)# ip pim bsr rp-candidate-policy my_bsr_rp_candidate_policy
This example shows how to disable message filtering:
switch(config)# no ip pim bsr rp-candidate-policy
Related Commands
|
|
|
|---|---|
ip pim dr-priority
To configure the designated router (DR) priority that is advertised in IPv4 Protocol Independent Multicast (PIM) hello messages, use the ip pim dr-priority command. To reset the DR priority to the default, use the no form of this command.
no ip pim dr-priority [ priority ]
Syntax Description
Priority value. The range is from 1 to 4294967295. The default is 1. |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure DR priority on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim dr-priority 5
This example shows how to reset DR priority on an interface to the default:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim dr-priority
Related Commands
|
|
|
|---|---|
ip pim event-history
To configure the size of the IPv4 Protocol Independent Multicast (PIM) event history buffers, use the ip pim event-history command. To revert to the default buffer size, use the no form of this command.
ip pim event-history { assert-receive | bidir | cli | hello | join-prune | null-register | packet | pim-internal | rp | vrf } size buffer-size
no ip pim event-history { assert-receive | bidir | cli | hello | join-prune | null-register | packet | pim-internal | rp | vrf } size buffer-size
Syntax Description
Configures the virtual routing and forwarding (VRF) event history buffer. |
|
Buffer size is one of the following values: disabled, large, medium, or small. The default buffer size is small. |
Command Default
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the size of the PIM hello event history buffer:
Related Commands
|
|
|
|---|---|
Displays information about the running-system PIM configuration. |
ip pim flush-routes
To remove routes when the IPv4 Protocol Independent Multicast (PIM) process is restarted, use the ip pim flush-routes command. To leave routes in place, use the no form of this command.
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
To display whether flush routes are configured, use this command line:
switch(config)# show running-config | include flush-routes
Examples
This example shows how to remove routes when the PIM process is restarted:
switch(config)# ip pim flush-routes
This example shows how to leave routes in place when the PIM process is restarted:
switch(config)# no ip pim flush-routes
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ip pim hello-authentication ah-md5
To enable an MD5 hash authentication key in IPv4 Protocol Independent Multicast (PIM) hello messages, use the ip pim hello-authentication ah-md5 command. To disable hello-message authentication, use the no form of this command.
ip pim hello-authentication ah-md5 auth-key
no ip pim hello-authentication ah-md5 [ auth-key ]
Syntax Description
MD5 authentication key. You can enter an unencrypted (cleartext) key, or one of these values followed by a space and the MD5 authentication key: |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Triple Data Encryption Standard (3-DES) is a strong form of encryption (168-bit) that allows sensitive information to be transmitted over untrusted networks. Cisco Type 7 encryption uses the algorithm from the Vigenère cipher.
Examples
This example shows how to enable a 3-DES encrypted key for PIM hello-message authentication:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim hello-authentication-ah-md5 3 myauthkey
This example shows how to disable PIM hello-message authentication:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim hello-authentication-ah-md5
Related Commands
|
|
|
|---|---|
ip pim hello-interval
To configure the IPv4 Protocol Independent Multicast (PIM) hello-message interval on an interface, use the ip pim hello-interval command. To reset the hello interval to the default, use the no form of this command.
ip pim hello-interval interval
no ip pim hello-interval [ interval ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
At a minimum interval, VPC vs non-VPC cases, and also with single vs dual sup cases, Basically for vPC and with dual sups one needs to use default timers. the neighbor hold time is automatically set to 3.5x this value. Also it is recommended to use BFD for PIM instead of non-default timers.
Examples
This example shows how to configure the PIM hello-message interval on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim hello-interval 20000
This example shows how to reset the PIM hello-message interval on an interface to the default:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim hello-interval
Related Commands
|
|
|
|---|---|
ip pim jp-policy
To filter IPv4 Protocol Independent Multicast (PIM) join-prune messages that are based on a route-map policy, use the ip pim jp-policy command. To disable filtering, use the no form of this command.
ip pim jp-policy policy-name [ in | out ]
no ip pim jp-policy [ policy-name ]
Syntax Description
Specifies that the system applies a filter only for incoming messages. |
|
Specifies that the system applies a filter only for outgoing messages. |
Command Default
Disabled; no filter is applied for either incoming or outgoing messages.
Command Modes
Command History
|
|
|
Usage Guidelines
The ip pim jp-policy command filters messages in both incoming and outgoing directions. To specify filtering only incoming messages, use the optional in keyword; to specify filtering only outgoing messages, use the optional out keyword. When you enter the command with no keywords, that is no explicit direction, the system rejects further configurations if given with explicit direction.
Use the ip pim jp-policy command to filter incoming messages. You can configure the route map to prevent state from being created in the multicast routing table.
You can specify group, group and source, or group and RP addresses to filter messages with the match ip multicast command.
Examples
This example shows how to filter PIM join-prune messages:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim jp-policy my_jp_policy
This example shows how to disable filtering:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim jp-policy
Related Commands
|
|
|
|---|---|
ip pim log-neighbor-changes
To generate syslog messages that list the IPv4 Protocol Independent Multicast (PIM) neighbor state changes, use the ip pim log-neighbor-changes command. To disable messages, use the no form of this command.
no ip pim log-neighbor-changes
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to generate syslog message that list the PIM neighbor state changes:
switch(config)# ip pim log-neighbor-changes
This example shows how to disable logging:
switch(config)# no ip pim log-neighbor-changes
Related Commands
|
|
|
|---|---|
ip pim neighbor-policy
To configure a route-map policy that determines which IPv4 Protocol Independent Multicast (PIM) neighbors should become adjacent, use the ip pim neighbor-policy command. To reset to the default, use the no form of this command.
ip pim neighbor-policy policy-name
no ip pim neighbor-policy [ policy-name ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
You can use the match ip address command in a route-map policy to specify which groups to become adjacent to.
Examples
This example shows how to configure a policy that determines which PIM neighbors should become adjacent:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim neighbor-policy
This example shows how to reset to the default:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim neighbor-policy
Related Commands
|
|
|
|---|---|
ip pim pre-build-spt
To prebuild the shortest path tree (SPT) for all known (S,G) in the routing table by triggering Protocol Independent Multicast (PIM) joins upstream, use the ip pim pre-build-spt command. To reset to the default, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
To prebuild the SPT for all known (S,G)s in the routing table by triggering PIM joins upstream, even in the absence of any receivers, use the ip pim pre-build-spt command.
By default, PIM (S,G) joins are triggered upstream only if the OIF-list for the (S,G) is not empty. It is useful in certain scenarios—for example, on the virtual port-channel (vPC) nonforwarding router—to prebuild the SPTs and maintain the (S,G) states even when the system is not forwarding on these routes. Prebuilding the SPT ensures faster convergence when a vPC failover occurs.
When you are running virtual port channels (vPCs), enabling this feature causes both vPC peer switches to join the SPT, even though only one vPC peer switch actually routes the multicast traffic into the vPC domain. This behavior results in the multicast traffic passing over two parallel paths from the source to the vPC switch pair, consuming bandwidth on both paths. Additionally, when both vPC peer switches join the SPT, one or more upstream devices in the network may be required to perform additional multicast replications to deliver the traffic on both parallel paths toward the receivers in the vPC domain.
Examples
This example shows how to prebuild the SPT in the absence of receivers:
switch(config)# vrf context Enterprise
switch(config-vrf)# ip pim pre-build-spt
switch(config-vrf)#
Related Commands
|
|
|
|---|---|
ip pim register-policy
To filter IPv4 Protocol Independent Multicast (PIM) Register messages that are based on a route-map policy, use the ip pim register-policy command. To disable message filtering, use the no form of this command.
ip pim register-policy policy-name
no ip pim register-policy [ policy-name ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can use the match ip multicast command in a route-map policy to specify the group or group and source addresses whose register messages that should be filtered.
Examples
This example shows how to enable filtering of PIM Register messages:
switch(config)# ip pim register-policy my_register_policy
This example shows how to disable message filtering:
switch(config)# no ip pim register-policy
Related Commands
|
|
|
|---|---|
ip pim register-rate-limit
To configure a rate limit for IPv4 Protocol Independent Multicast (PIM) data registers, use the ip pim register-rate-limit command. To remove a rate limit, use the no form of this command.
ip pim register-rate-limit rate
no ip pim register-rate-limit [ rate ]
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a rate limit for PIM data registers:
switch(config)# ip pim register-rate-limit 1000
This example shows how to remove a rate limit:
switch(config)# no ip pim register-rate-limit
Related Commands
|
|
|
|---|---|
ip pim rp-address
To configure an IPv4 Protocol Independent Multicast (PIM) static route processor (RP) address for a multicast group range, use the ip pim rp-address command. To remove a static RP address, use the no form of this command.
ip pim rp-address rp-address [ group-list prefix | override | route-map policy-name ] [ bidir ]
no ip pim rp-address rp-address [ group-list prefix | override | route-map policy-name ] [ bidir ]
Syntax Description
(Optional) Specifies the RP address. The RP address overrides the dynamically learned RP addresses. |
|
(Optional) Specifies to handle a group range in PIM bidirectional (Bidir) mode. |
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The match ip multicast command is the only match command that is evaluated in the route map. You can the specify group prefix to filter messages with the match ip multicast command.
Customers can use this “override” provision, if they want the static RPs always to override the dynamic ones.
Examples
This example shows how to configure a PIM static RP address for a serving group range and to override any dynamically learned (through BSR) RP addresses:
switch(config)# ip pim rp-address 1.1.1.1 group-list 225.1.0.0/16 override
This example shows how to configure a PIM static RP address for a group range:
switch(config)# ip pim rp-address 192.0.2.33 group-list 224.0.0.0/9
This example shows how to remove a static RP address:
switch(config)# no ip pim rp-address 192.0.2.33
Related Commands
|
|
|
|---|---|
ip pim rp-candidate
To configure the router as an IPv4 Protocol Independent Multicast (PIM) bootstrap router (BSR) roure processor (RP) candidate, use the ip pim rp-candidate command. To remove the router as an RP candidate, use the no form of this command.
ip pim [ bsr ] rp-candidate { ethernet slot / port | loopback if_number | port-channel number } { group-list prefix } [ priority priority ] [ interval interval ] [ bidir ]
no ip pim [ bsr ] rp-candidate { ethernet slot / port | loopback if_number | port-channel number } { group-list prefix } [ priority priority ] [ interval interval ] [ bidir ]
Syntax Description
Command Default
The RP priority is 192.
The BSR message interval is 60 seconds.
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
We recommend that you configure the candidate RP interval to be a minimum of 15 seconds.
Using this route map, you can add a range of group lists that this candidate-RP can serve.
Note Use the same configuration guidelines for the route-map auto-rp-range that you used when you created a route map for static RPS.
Examples
This example shows how to configure the router as a PIM BSR RP candidate:
switch(config)# ip pim rp-candidate e 2/11 group-list 239.0.0.0/24
This example shows how to remove the router as an RP candidate:
switch(config)# no ip pim rp-candidate
Related Commands
|
|
|
|---|---|
ip pim send-rp-announce
To configure an IPv4 Protocol Independent Multicast (PIM) Auto-RP candidate route processor (RP), use the ip pim send-rp-announce command. To remove an Auto-RP candidate RP, use the no form of this command.
ip pim send-rp-announce { ethernet slot / port | loopback if_number | port-channel number } { group-list prefix } {[ scope ttl ] | [ interval interval ] | [ bidir ]}
no ip pim send-rp-announce [{ ethernet slot / port | loopback if_number | port-channel number } { group-list prefix } {[ scope ttl ] | [ interval interval ] | [ bidir ]}
Syntax Description
Command Default
The TTL is 32.
The Auto-RP Announce message interval is 60 seconds.
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The scope, and interval, and bidir keywords can be entered once and in any order.
The ip pim auto-rp rp-candidate command is an alternative form of this command.
Examples
This example shows how to configure a PIM Auto-RP candidate RP:
switch(config)# ip pim send-rp-announce ethernet 2/1 group-list 239.0.0.0/24
This example shows how to remove a PIM Auto-RP candidate RP:
switch(config)# no ip pim send-rp-announce ethernet 2/1 group-list 239.0.0.0/24
Related Commands
|
|
|
|---|---|
ip pim send-rp-discovery
To configure the router as an IPv4 Protocol Independent Multicast (PIM) Auto-RP mapping agent that sends RP-Discovery messages, use the ip pim send-rp-discovery command. To remove the configuration, use the no form of this command.
ip pim send-rp-discovery { ethernet slot / port | loopback if_number | port-channel number } [ scope ttl ]
no ip pim send-rp-discovery [{ ethernet slot / port | loopback if_number | port-channel number } [ scope ttl ]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The ip pim auto-rp mapping-agent command is an alternative form of this command.
Examples
This example shows how to configure an Auto-RP mapping agent:
switch(config)# ip pim send-rp-discovery ethernet 2/1
This example shows how to remove an Auto-RP mapping agent:
switch(config)# no ip pim send-rp-discovery ethernet 2/1
Related Commands
|
|
|
|---|---|
ip pim sg-expiry-timer
To adjust the (S, G) expiry timer interval for Protocol Independent Multicast sparse mode (PIM-SM) (S, G) multicast routes, use the ip pim sg-expiry-timer command. To reset to the default values, use the no form of the command.
ip pim [ sparse ] sg-expiry-timer seconds [ sg-list route-map ]
no ip pim [ sparse ] sg-expiry-timer seconds [ sg-list route-map ]
Syntax Description
Expiry-timer interval. The range is from 181 to 57600 seconds. |
|
(Optional) Specifies S,G values to which the timer applies. The route map name can be a maximum of 100 alphanumeric characters. |
Command Default
The default expiry time is 180 seconds.
The timer applies to all (S, G) entries in the routing table.
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the expiry interval to 300 seconds for all (S, G) entries:
switch(config)# vrf context Enterprise
switch(config-vrf)# ip pim sg-expiry-timer 300
switch(config-vrf)#
Related Commands
|
|
|
|---|---|
ip pim sparse-mode
To enable IPv4 Protocol Independent Multicast (PIM) sparse mode on an interface, use the ip pim sparse-mode command. To disable PIM on an interface, use the no form of this command.
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable PIM sparse mode on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# ip pim sparse-mode
This example shows how to disable PIM on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# no ip pim
Related Commands
|
|
|
|---|---|
ip pim spt-threshold infinity
To create the IPv4 Protocol Independent Multicast (PIM) (*, G) state only (where no source state is created), use the ip pim spt-threshold infinity command. To remove the creation of the shared tree state only, use the no form of this command.
ip pim spt-threshold infinity group-list route-map-name
no ip pim spt-threshold infinity [group-list route-map-name]
Syntax Description
Route-map policy name that defines the group prefixes where this feature is applied. A route-map policy name can be a maximum of 100 alphanumeric characters. |
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can specify up to 500 sequence lines in a route map.
The match ip multicast command is the only match command that is evaluated in the route map. You can specify the group prefix to filter messages with the match ip multicast command.
You must have enabled PIM before you can use the ip pim spt-threshold infinity command.
Note This command is not supported for virtual port channels (vPC/vPC+).
This command requires the Enterprise Services license.
Note The ip pim use-shared-tree-only group-list command performs the same function as the ip pim spt-threshold infinity group-list command. You can choose to use either command to implement this task.
Examples
This example shows how to create the PIM (*, G) state only for the group prefixes defined in my_group_map:
This example shows how to remove the creation of the (*, G) state only:
Related Commands
|
|
|
|---|---|
ip pim ssm policy
To configure group ranges for Source Specific Multicast (SSM) using a route-map policy, use the ip pim ssm policy command. To remove the SSM group range policy, use the no form of this command.
no ip pim ssm policy policy-name
Syntax Description
Route-map policy name that defines the group prefixes where this feature is applied. |
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a group range for SSM:
switch(config)# ip pim ssm policy my_ssm_policy
This example shows how to reset the group range to the default:
switch(config)# no ip pim ssm policy my_ssm_policy
Related Commands
|
|
|
|---|---|
ip pim ssm
To configure group ranges for Source Specific Multicast (SSM), use the ip pim ssm range command. To reset the SSM group range to the default, use the no form of this command with the none keyword.
ip pim ssm { range { groups | none } | route-map policy-name }
no ip pim ssm { range { groups | none } | route-map policy-name }
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The match ip multicast command is the only match command that is evaluated in the route map. You can specify the group prefix to filter messages with the match ip multicast command.
Examples
This example shows how to configure a group range for SSM:
switch(config)# ip pim ssm range 239.128.1.0/24
This example shows how to reset the group range to the default:
switch(config)# no ip pim ssm range none
This example shows how to remove all group ranges:
switch(config)# ip pim ssm range none
Related Commands
|
|
|
|---|---|
ip pim state-limit
To configure a maximum number of IPv4 Protocol Independent Multicast (PIM) state entries in the current virtual routing and forwarding (VRF) instance, use the ip pim state-limit command. To remove the limit on state entries, use the no form of this command.
ip pim state-limit max-states [ reserved policy-name max-reserved ]
no ip pim state-limit [ max-states [ reserved policy-name max-reserved ]]
Syntax Description
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
To display commands where state limits are configured, use this command line:
switch(config)# show running-config | include state-limit
Examples
This example shows how to configure a state entry limit with a number of state entries reserved for routes in a policy map:
switch(config)# ip pim state-limit 100000 reserved my_reserved_policy 40000
This example shows how to remove the limits on state entries:
switch(config)# no ip pim state-limit
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ip pim use-shared-tree-only
To create the IPv4 Protocol Independent Multicast (PIM) (*, G) state only (where no source state is created), use the ip pim use-shared-tree-only command. To remove the creation of the shared tree state only, use the no form of this command.
ip pim use-shared-tree-only group-list policy-name
no ip pim use-shared-tree-only [ group-list policy-name ]
Syntax Description
Route-map policy name that defines the group prefixes where this feature is applied. |
Command Default
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can use the match ip multicast command in a route-map policy to specify the groups where shared trees should be enforced.
This command requires the LAN Base Services license.
Note The ip pim use-shared-tree-only group-list command performs the same function as the ip pim spt-threshold infinity group-list command. You can choose to use either command to implement this task.
Examples
This example shows how to create the PIM (*, G) state only for the group prefixes defined in my_group_policy:
switch(config)# ip pim use-shared-tree-only group-list my_group_policy
This example shows how to remove the creation of the (*, G) state only:
switch(config)# no ip pim use-shared-tree-only
Related Commands
|
|
|
|---|---|
ip routing multicast event-history
To configure the size of the IPv4 Multicast Routing Information Base (MRIB) event history buffers, use the ip routing multicast event-history command. To revert to the default buffer size, use the no form of this command.
ip routing multicast event-history { cli | mfdm-debugs | mfdm-events | mfdm-stats | rib | vrf } size buffer-size
no ip routing multicast event-history { cli | mfdm | mfdm-stats | rib | vrf } size buffer-size
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
To display configured buffer sizes, use this command line:
Examples
This example shows how to configure the size of the MRIB MFDM event history buffer:
Related Commands
|
|
|
|---|---|
Displays information in the IPv4 MRIB event history buffers. |
|
Displays information about the running-system configuration. |
ip routing multicast holddown
To configure the IPv4 multicast routing initial holddown period, use the ip routing multicast holddown command. To revert to the default holddown period, use the no form of this command.
[ ip | ipv4 ] routing multicast holddown holddown-period
no [ ip | ipv4 ] routing multicast holddown holddown-period
Syntax Description
Initial route holddown period in seconds. The range is from 90 to 210. Specify 0 to disable the holddown period. The default is 210. |
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
To display the holddown period configuration, use this command line:
Examples
This example shows how to configure the routing holddown period:
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ip routing multicast software-replicate
To enable software replication of IPv4 Protocol Independent Multicast (PIM) Any Source Multicast (ASM) packets that are leaked to the software for state creation, use the ip routing multicast software-replicate command. To reset to the default, use the no form of this command.
ip routing multicast software-replicate
no ip routing multicast software-replicate
Syntax Description
Command Default
Command Modes
Command History
|
|
|
Usage Guidelines
By default, these packets are used by the software only for (S,G) state creation and then dropped.
Examples
This example shows how to enable software replication of IPv4 PIM ASM packets:
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ipv6 pim anycast-rp
To configure an IPv6 Protocol Independent Multicast (PIM6) Anycast-RP peer for the specified Anycast-RP address, use the ipv6 pim anycast-rp command. To remove the peer, use the no form of this command.
ipv6 pim anycast-rp anycast-rp rp-addr
no ipv6 pim anycast-rp anycast-rp rp-addr
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Each command with the same Anycast-RP address forms an Anycast-RP set. The IP addresses of RPs are used for communication with RPs in the set.
Examples
This example shows how to configure a PIM Anycast-RP peer:
switch(config)# ipv6 pim anycast-rp 2001:0db8:0:abcd::3 2001:0db8:0:abcd::31
This example shows how to remove a peer:
switch(config)# no ipv6 pim anycast-rp 2001:0db8:0:abcd::3 2001:0db8:0:abcd::31
Related Commands
|
|
|
|---|---|
ipv6 pim bidir-rp-limit
To configure the number of bidirectional (Bidir) RPs for use in IPv6 Protocol Independent Multicast (PIM6), use the ipv6 pim bidir-rp-limit command. To reset the number of RPs to the default, use the no form of this command.
no ipv6 pim bidir-rp-limit limit
Syntax Description
Limit for the number of Bidir RPs permitted in PIM6. The range is from 0 to 8. The default is 2. |
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Because the maximum ordinal count of designated forwarders (DFs) is 8, the PIM and IPv6 PIM RP limits should be no more than 8.
To display the Bidir RP limit configured, use this command line:
switch(config)# show running-config | include bidir
Examples
This example shows how to configure the number of Bidir RPs:
switch(config)# ipv6 pim bidir-rp-limit 6
This example shows how to reset the number of Bidir RPs to the default:
switch(config)# no ipv6 pim bidir-rp-limit 6
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ipv6 pim border
To configure an interface on an IPv6 Protocol Independent Multicast (PIM6) border, use the ipv6 pim border command. To remove an interface from a PIM6 border, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure an interface on a PIM6 border:
switch(config)# ipv6 pim border
This example shows how to remove an interface from a PIM6 border:
switch(config)# no ipv6 pim border
Related Commands
|
|
|
|---|---|
ipv6 pim bsr bsr-policy
To enable filtering of IPv6 Protocol Independent Multicast (PIM6) bootstrap router (BSR) messages by the BSR client routers based on a route-map policy, use the ipv6 pim bsr bsr-policy command. To disable filtering, use the no form of this command.
ipv6 pim bsr bsr-policy policy-name
no ipv6 pim bsr bsr-policy [ policy-name ]
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can specify which source addresses to filter messages from with the match ipv6 multicast command in a route-map policy.
Examples
This example shows how to enable filtering of BSR messages:
switch(config)# interface ethernet 2/2
switch(config-if)# ipv6 pim bsr bsr-policy my_bsr_policy
This example shows how to disable filtering:
switch(config)# interface ethernet 2/2
switch(config-if)# no ipv6 pim bsr bsr-policy
Related Commands
|
|
|
|---|---|
ipv6 pim bsr-candidate
To configure the router as an IPv6 Protocol Independent Multicast (PIM6) bootstrap router (BSR) candidate, use the ipv6 pim bsr-candidate command. To remove a router as a BSR candidate, use the no form of this command.
ipv6 pim [ bsr ] bsr-candidate if-type if-number [ hash-len hash-len ] [ priority priority ]
no ipv6 pim [ bsr ] bsr-candidate [ if-type if-number ] [ hash-len hash-len ] [ priority priority ]
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a router as a BSR candidate:
switch(config)# ipv6 pim bsr-candidate ethernet 2/2
This example shows how to remove a router as a BSR candidate:
switch(config)# no ipv6 pim bsr-candidate
Related Commands
|
|
|
|---|---|
ipv6 pim bsr forward
To listen to and forward IPv6 Protocol Independent Multicast (PIM6) bootstrap router (BSR) and Candidate-RP messages, use the ipv6 pim bsr forward command. To disable listening and forwarding, use the no form of this command.
ipv6 pim bsr forward [ listen ]
no ipv6 pim bsr [ forward [ listen ]]
Syntax Description
(Optional) Specifies to listen to Bootstrap and Candidate-RP messages. |
|
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
A router configured as either a candidate RP or a candidate BSR will automatically listen to and forward all BSR protocol messages, unless an interface is configured with the domain border feature.
This command has the same functionality as the ipv6 pim bsr listen command.
Examples
This example shows how to listen to and forward BSR and Candidate-RP messages:
switch(config)# ipv6 pim bsr listen forward
This example shows how to disable listening and forwarding:
switch(config)# no ipv6 pim bsr listen forward
Related Commands
|
|
|
|---|---|
ipv6 pim bsr listen
To listen to and forward IPv6 Protocol Independent Multicast (PIM6) bootstrap router (BSR) and Candidate-RP messages, use the ipv6 pim bsr listen command. To disable listening and forwarding, use the no form of this command.
ipv6 pim bsr listen [ forward ]
no ipv6 pim bsr [ listen [ forward ]]
Syntax Description
(Optional) Specifies to listen to Bootstrap and Candidate-RP messages. |
|
(Optional) Specifies to forward Bootstrap and Candidate-RP messages. |
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
A router configured as either a candidate RP or a candidate BSR will automatically listen to and forward all BSR protocol messages, unless an interface is configured with the domain border feature.
This command has the same functionality as the ipv6 pim bsr forward command
Examples
This example shows how to listen to and forward BSR and Candidate-RP messages:
switch(config)# ipv6 pim bsr listen forward
This example shows how to disable listening and forwarding:
switch(config)# no ipv6 pim bsr listen forward
Related Commands
|
|
|
|---|---|
ipv6 pim bsr rp-candidate-policy
To filter IPv6 Protocol Independent Multicast (PIM6) bootstrap router (BSR) Candidate-RP messages that are based on a route-map policy, use the ipv6 pim bsr rp-candidate-policy command. To disable filtering, use the no form of this command.
ipv6 pim bsr rp-candidate-policy policy-name
no ipv6 pim bsr rp-candidate-policy [ policy-name ]
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can specify the RP and group addresses, and whether the type is Bidir or ASM with the match ipv6 multicast command in a route-map policy.
Examples
This example shows how to filter Candidate-RP messages:
switch(config)# ipv6 pim bsr rp-candidate-policy my_bsr_rp_candidate_policy
This example shows how to disable message filtering:
switch(config)# no ipv6 pim bsr rp-candidate-policy
Related Commands
|
|
|
|---|---|
ipv6 pim dr-priority
To configure the designated router (DR) priority that is advertised in IPv6 Protocol Independent Multicast (PIM6) hello messages, use the ipv6 pim dr-priority command. To reset the DR priority to the default, use the no form of this command.
no ipv6 pim dr-priority [ priority ]
Syntax Description
Priority value. The range is from 1 to 4294967295. The default is 1. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the DR priority on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# ipv6 pim dr-priority 5
This example shows how to reset the DR priority on an interface to the default:
switch(config)# interface ethernet 2/2
switch(config-if)# no ipv6 pim dr-priority
Related Commands
|
|
|
|---|---|
ipv6 pim event-history
To configure the size of the IPv6 Protocol Independent Multicast (PIM6) event history buffers, use the ipv6 pim event-history command. To revert to the default buffer size, use the no form of this command.
ipv6 pim event-history { assert-receive | bidir | cli | hello | join-prune | null-register | packet | pim6-internal | rp | vrf } size buffer-size
no ipv6 pim event-history { assert-receive | bidir | cli | hello | join-prune | null-register | packet | pim6-internal | rp | vrf } size buffer-size
Syntax Description
Configures the virtual routing and forwarding (VRF) event history buffer. |
|
Buffer size is one of the following values: disabled, large, medium, or small. The default buffer size is small. |
Defaults
Command Modes
network-admin
network-operator
vdc-admin
vdc-operator
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the size of the PIM6 hello event history buffer:
Related Commands
|
|
|
|---|---|
Displays information about the running-system PIM6 configuration. |
ipv6 pim flush-routes
To remove routes when the IPv6 Protocol Independent Multicast (PIM6) process is restarted, use the ipv6 pim flush-routes command. To leave routes in place, use the no form of this command.
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
To display whether flush routes are configured, use this command line:
switch(config)# show running-config | include flush-routes
Examples
This example shows how to remove routes when the PIM process is restarted:
switch(config)# ipv6 pim flush-routes
This example shows how to leave routes in place when the PIM process is restarted:
switch(config)# no ipv6 pim flush-routes
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ipv6 pim hello-interval
To configure the IPv6 Protocol Independent Multicast (PIM6) hello-message interval on an interface, use the ipv6 pim hello-interval command. To reset the hello interval to the default, use the no form of this command.
ipv6 pim hello-interval interval
no ipv6 pim hello-interval [ interval ]
Syntax Description
Interval in milliseconds. The range is from 1 to 4294967295. The default is 30000. |
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure the PIM6 hello-message interval on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# ipv6 pim hello-interval 20000
This example shows how to reset the PIM6 hello message-interval on an interface to the default:
switch(config)# interface ethernet 2/2
switch(config-if)# no ipv6 pim hello-interval
Related Commands
|
|
|
|---|---|
ipv6 pim jp-policy
To filter IPv6 Protocol Independent Multicast (PIM6) join-prune messages that are based on a route-map policy, use the ipv6 pim jp-policy command. To disable filtering, use the no form of this command.
ipv6 pim jp-policy policy-name [ in | out ]
no ipv6 pim jp-policy [ policy-name ]
Syntax Description
Specifies that the system applies a filter only for incoming messages. |
|
Specifies that the system applies a filter only for outgoing messages. |
Defaults
Disabled; no filter is applied for either incoming or outgoing messages.
Command Modes
Command History
|
|
|
Usage Guidelines
Beginning with Cisco NX-OS Release 4.2(3), the ipv6 pim jp-policy command filters messages in both incoming and outgoing directions. To specify filtering only incoming messages, use the optional in keyword; to specify filtering only outgoing messages, use the optional out keyword. When you enter the command with no arguments, that is no explicit direction, the system rejects further configurations if given with explicit direction.
You can specify group, group and source, or group and RP addresses to filter messages with the match ipv6 multicast command.
Examples
This example shows how to filter PIM join-prune messages:
switch(config)# interface ethernet 2/2
switch(config-if)# ipv6 pim jp-policy my_jp_policy
This example shows how to disable filtering:
switch(config)# interface ethernet 2/2
switch(config-if)# no ipv6 pim jp-policy
Related Commands
|
|
|
|---|---|
ipv6 pim log-neighbor-changes
To generate syslog messages that list the IPv6 Protocol Independent Multicast (PIM6) neighbor state changes, use the ipv6 pim log-neighbor-changes command. To disable messages, use the no form of this command.
no ipv6 pim log-neighbor-changes
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to generate syslog message that list the PIM6 neighbor state changes:
switch(config)# ipv6 pim log-neighbor-changes
This example shows how to disable logging:
switch(config)# no ipv6 pim log-neighbor-changes
Related Commands
|
|
|
|---|---|
ipv6 pim neighbor-policy
To configure a route-map policy that determines which IPv6 Protocol Independent Multicast (PIM6) neighbors should become adjacent, use the ipv6 pim neighbor-policy command. To reset to the default, use the no form of this command.
ipv6 pim neighbor-policy policy-name
no ipv6 pim neighbor-policy [ policy-name ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
You can use the match ipv6 address command in a route-map policy to specify which groups to become adjacent to.
Examples
This example shows how to configure a policy that determines which PIM6 neighbors should become adjacent:
switch(config)# interface ethernet 2/2
switch(config-if)# ipv6 pim neighbor-policy
This example shows how to reset to the default:
switch(config)# interface ethernet 2/2
switch(config-if)# no ipv6 pim neighbor-policy
Related Commands
|
|
|
|---|---|
ipv6 pim register-policy
To filter IPv6 Protocol Independent Multicast (PIM6) Register messages that are based on a route-map policy, use the ipv6 pim register-policy command. To disable message filtering, use the no form of this command.
ipv6 pim register-policy policy-name
no ipv6 pim register-policy [ policy-name ]
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
You can use the match ipv6 multicast command in a route-map policy to specify the group or group and source addresses whose register messages that should be filtered.
To display the configured register policy, use this command line:
switch(config)# show running-config | include register-policy
Examples
This example shows how to filter PIM6 Register messages:
switch(config)# ipv6 pim register-policy my_register_policy
This example shows how to disable message filtering:
switch(config)# no ipv6 pim register-policy
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ipv6 pim register-rate-limit
To configure a rate limit for IPv6 Protocol Independent Multicast (PIM6) data registers, use the ipv6 pim register-rate-limit command. To remove a rate limit, use the no form of this command.
ipv6 pim register-rate-limit rate
no ipv6 pim register-rate-limit [ rate ]
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to configure a rate limit for PIM6 data registers:
switch(config)# ipv6 pim register-rate-limit 1000
This example shows how to remove a rate limit:
switch(config)# no ipv6 pim register-rate-limit
Related Commands
|
|
|
|---|---|
ipv6 pim rp-address
To configure an IPv6 Protocol Independent Multicast (PIM6) static route processor (RP) address for a multicast group range, use the ipv6 pim rp-address command. To remove a static RP address, use the no form of this command.
ipv6 pim rp-address rp-address [ group-list prefix | route-map policy-name ] [ bidir ]
no ipv6 pim rp-address rp-address [ group-list prefix | route-map policy-name ] [ bidir ]
Syntax Description
IPv6 address of the router, which is the RP for the group range. |
|
(Optional) Specifies to handle group ranges in PIM6 bidirectional (Bidir) mode. |
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The match ipv6 multicast command is the only match command that is evaluated in the route map. You can specify the group prefix to filter messages with the match ipv6 multicast command.
Examples
This example shows how to configure a PIM6 static RP address for a group range:
switch(config)# ipv6 pim rp-address 2001:0db8:0:abcd::1 group-list ff1e:abcd:def1::0/96
This example shows how to remove a static RP address:
switch(config)# no ipv6 pim rp-address 2001:0db8:0:abcd::1
Related Commands
|
|
|
|---|---|
ipv6 pim rp-candidate
To configure the router as an IPv6 Protocol Independent Multicast (PIM6) bootstrap router (BSR) route processor (RP) candidate, use the ipv6 pim rp-candidate command. To remove the router as an RP candidate, use the no form of this command.
ipv6 pim [ bsr ] rp-candidate if-type if-number group-list prefix [ priority priority ] [ interval interval ] [ bidir ]
no ipv6 pim [ bsr ] rp-candidate [ if-type if-number ] [ group-list prefix ] [ priority priority ] [ interval interval ] [ bidir ]
Syntax Description
Defaults
The RP priority is 192.
The BSR message interval is 60 seconds.
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
We recommend that you configure the candidate RP interval to a minimum of 15 seconds.
Examples
This example shows how to configure the router as a PIM6 BSR RP candidate:
switch(config)# ipv6 pim rp-candidate e 2/11 group-list ff1e:abcd:def1::0/24
This example shows how to remove the router as an RP candidate:
switch(config)# no ipv6 pim rp-candidate
Related Commands
|
|
|
|---|---|
ipv6 pim sparse-mode
To enable IPv6 Protocol Independent Multicast (PIM6) sparse mode on an interface, use the ipv6 pim sparse-mode command. To disable PIM6 on an interface, use the no form of this command.
Syntax Description
Defaults
Command Modes
Command History
|
|
|
Usage Guidelines
Examples
This example shows how to enable PIM6 sparse mode on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# ipv6 pim sparse-mode
This example shows how to disable PIM6 on an interface:
switch(config)# interface ethernet 2/2
switch(config-if)# no ipv6 pim
Related Commands
|
|
|
|---|---|
ipv6 pim ssm range
To configure IPv6 Protocol Independent Multicast (PIM6) group ranges for Source Specific Multicast (SSM), use the ipv6 pim ssm range command. To reset the SSM group range to the default, use the no form of this command with the none keyword.
ipv6 pim ssm { range { groups | none ] | route-map policy-name }
no ipv6 pim ssm { range [ groups | none ] | route-map policy-name }
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
The match ipv6 multicast command is the only match command that is evaluated in the route map. You can specify the group prefix to filter messages with the match ipv6 multicast command.
Examples
This example shows how to configure a PIM6 group range for SSM:
switch(config)# ipv6 pim ssm range FF30::0/32
This example shows how to reset the group range to the default:
switch(config)# no ipv6 pim ssm range none
This example shows how to remove all group ranges:
switch(config)# ipv6 pim ssm range none
Related Commands
|
|
|
|---|---|
ipv6 pim state-limit
To configure a maximum number of IPv6 Protocol Independent Multicast (PIM6) state entries in the current virtual routing and forwarding (VRF) instance, use the ipv6 pim state-limit command. To remove the limit on state entries, use the no form of this command.
ipv6 pim state-limit max-states [ reserved policy-name max-reserved ]
no ipv6 pim state-limit [ max-states [ reserved policy-name max-reserved ]]
Syntax Description
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Usage Guidelines
To display commands where state limits are configured, use this command line:
Examples
This example shows how to configure a state entry limit with a number of state entries reserved for routes in a policy map:
switch(config)# ipv6 pim state-limit 100000 reserved my_reserved_policy 40000
This example shows how to remove the limits on state entries:
switch(config)# no ipv6 pim state-limit
Related Commands
|
|
|
|---|---|
Displays information about the running-system configuration. |
ipv6 pim use-shared-tree-only
To create IPv6 Protocol Independent Multicast (PIM6) (*, G) state only (where no source state is created), use the ipv6 pim use-shared-tree-only command. To remove the creation of shared tree state only, use the no form of this command.
ipv6 pim use-shared-tree-only group-list policy-name
no ipv6 pim use-shared-tree-only [ group-list policy-name ]
Syntax Description
Route-map policy name that defines the group prefixes where this feature is applied. |
Defaults
Command Modes
Global configuration mode
VRF configuration mode
Command History
|
|
|
Keyword group-list was added and a route-map policy name is used to define groups. |
Usage Guidelines
You can use the match ipv6 multicast command in a route-map policy to specify the groups where shared trees should be enforced.
Examples
This example shows how to create the PIM6 (*, G) state only for the group prefixes defined in my_group_policy:
switch(config)# ipv6 pim use-shared-tree-only group-list my_group_policy
This example shows how to remove the creation of the (*, G) state only:
switch(config)# no ipv6 pim use-shared-tree-only
Related Commands
|
|
|
|---|---|
Feedback