ip pgm host
![]() Note |
Support for the PGM Host feature has been removed. Use of this command is not recommended. |
To enable Pragmatic General Multicast (PGM) Host, use the ip pgm host command in global configuration mode. To disable PGM Host and close all open PGM Host traffic sessions, use the no form of this command.
ip pgm host [source-interface interface-type interface-number | connection-parameter]
no ip pgm host
Syntax Description
source-interface interface-type interface-number |
(Optional) Specifies the interface type and number on which to run PGM Host. |
connection-parameter |
(Optional) Configures advanced PGM Host connection parameters. The optional configuration parameters should be configured only by experts in PGM technology. See the table below for a comprehensive list of the optional connection parameters and their definitions. |
Command Default
PGM Host is not enabled.
Command Modes
Global configuration
Command History
Release |
Modification |
---|---|
12.1(1)T |
This command was introduced. |
12.2(33)SRA |
This command was integrated into Cisco IOS Release 12.2(33)SRA. |
12.2SX |
This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware. |
Usage Guidelines
Using the ip pgm host command without a keyword or an argument enables PGM Host on the router and configures the router to source PGM packets through a virtual host interface.
Specifying a physical or logical interface type (for example, an Ethernet, serial, or loopback interface) with the ip pgm host source-interface command configures the router to source PGM packets out of the physical or logical interface.
![]() Note |
You must first enable PGM Host globally on the router using the ip pgm host command before sourcing PGM packets out of a physical or logical interface using the ip pgm host source-interface command. |
Sourcing PGM packets through a virtual host interface enables the router to send and receive PGM packets through any router interface. The virtual host interface also serves as the interface to the multicast applications that reside at the PGM network layer.
Sourcing IP multicast traffic out a specific physical or logical interface configures the router to send PGM packets out that interface only and to receive packets on any router interface.
When both PGM Host and Router Assist are enabled on the router, the router can process received PGM packets as a virtual PGM Host, originate PGM packets and serve as its own first hop PGM network element, and forward received PGM packets. Refer to the “Configuring PGM Host and Router Assist” chapter of the Cisco IOS IP Configuration Guide for more information about PGM Router Assist.
The table below lists the available parameters for the connection-parameter argument. The parameters should be configured only by experts in PGM technology. Use the no ip pgm host connection-parameter command to return a parameter to its default value.
Parameter |
Definition |
---|---|
ihb-max milliseconds |
(Optional) Sets the source path message (SPM) interheartbeat timer maximum. The default is 10000 milliseconds (ms). |
ihb-min milliseconds |
(Optional) Sets the SPM interheartbeat timer minimum. The default is 1000 ms. |
join milliseconds |
(Optional) Sets the amount of time the PGM Host waits, when running in router mode, for client requests. The default is 0 ms. |
nak-gen-ivl milliseconds |
(Optional) Sets the amount of time the PGM Host waits for a PGM negative acknowledgment (NAK) data packet. The default is 60000 ms. |
nak-rb-ivl milliseconds |
(Optional) Sets the amount of time the PGM Host waits before sending a PGM NAK data packet. The default is 500 ms. |
nak-rdata-ivl milliseconds |
(Optional) Sets the amount of time the PGM Host waits for a re-sent PGM NAK (NAK RDATA) data packet. The default is 2000 ms. |
nak-rpt-ivl milliseconds |
(Optional) Sets the amount of time the PGM Host waits for a PGM NAK confirmation (NAK NCF) data packet. The default is 2000 ms. |
ncf-max packets-per-second |
(Optional) Sets the maximum number of PGM NAK confirmation data packets (NAK NCFs) the PGM Host sends per second. The default is infinite. |
rx-buffer-mgmt {full | minimum } |
(Optional) Sets the type of receive data buffers (full or minimum) for the PGM Host. The default is minimum. |
spm-ambient-ivl milliseconds |
(Optional) Sets the amount of time the PGM Host waits for a PGM source path message (SPM) ambient data packet. The default is 6000 ms. |
spm-rpt-ivl milliseconds |
(Optional) Sets the amount of time the PGM Host waits for a PGM SPM repeat data packet. The default is 3000 ms. |
stream-type {apdu | byte } |
(Optional) Sets the data stream type (apdu or byte) for the PGM Host. The default is apdu. |
tpdu-size number |
(Optional) Sets the size of the source transport data unit (TPDU) for the PGM Host. The available range is 41 through 16384 bytes. The default is 1400 bytes. |
ttl number |
(Optional) Sets the time-to-live (TTL) value on the PGM Host for sent multicast data packets. The default is 255 hops. The TTL value for a packet is decremented by 1 as the packet passes through a router. |
tx-buffer-mgmt {keep | return } |
(Optional) Sets the type of transmit data buffers (keep or return) for the PGM Host. The default is return. |
tx-adv-method {data | time } |
(Optional) Sets the type of advanced transmit window method (data or time) for the PGM Host. The default is time. |
txw-adv-secs milliseconds |
(Optional) Sets the size of the advanced transmit window for the PGM Host. The default is 6000 ms. |
txw-adv-timeout-max milliseconds |
(Optional) Sets the time after which a transmit window will be advanced regardless of observed NAKs. |
txw-rte bytes-per-second |
(Optional) Sets the data transmit rate for the PGM Host. The default is 16384 bytes per second. |
txw-secs milliseconds |
(Optional) Sets the data transmit window size for the PGM Host. The default is 30000 ms. |
txw-timeout-max milliseconds |
(Optional) Sets the amount of time the PGM Host waits for data packets, even if the PGM Host receives PGM NAK data packets. The default is 3600000 ms. |
Examples
The following example enables PGM Host (both the source and receiver part of the PGM network layer) globally on the router and configures the router to source PGM packets through a virtual host interface:
ip pgm host
The following example enables PGM Host globally on the router and configures the router to source PGM packets out of physical Ethernet interface 0/1:
ip pgm host
ip pgm host source-interface ethernet 0/1