Cisco ASR 9000 Series Aggregation Services Router System Management Configuration Guide, Release 5.1.x
Configuring PTP on the Cisco ASR 9000 Series Router
Downloads: This chapterpdf (PDF - 1.48MB) The complete bookPDF (PDF - 5.04MB) | Feedback

Contents

Configuring PTP on the Cisco ASR 9000 Series Router

Precision Time Protocol (PTP) is a protocol that provides a method of distributing time around the network. PTP support is based on the IEEE 1588-2008 standard.

This module describes the tasks you need to configure PTP on the Cisco IOS XR software.

For more information about PTP on the Cisco IOS XR software and complete descriptions of the PTP commands listed in this module, see Additional References. To locate documentation for other commands that might appear in the course of running a configuration task, search online in Cisco ASR 9000 Series Aggregation Services Router Commands Master List.

Table 1 Feature History for Implementing PTP on Cisco IOS XR Software

Release

Modification

Release 4.2.0

This feature was introduced.

Release 4.3.0

Support for hybrid mode and Telecom Profile were added.

Release 4.3.1

Support for PTP in Ethernet link bundles was added.

This module contains the following topics:

Prerequisites for Implementing PTP on Cisco IOS XR Software

You must be in a user group associated with a task group that includes the proper task IDs. The command reference guides include the task IDs required for each command. If you suspect user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Information About Configuring PTP

PTP Implementation

IEEE Standard 1588-2008 defines a method for distributing time around a network using the Precision Time Protocol (PTP) version 2. PTP ensures that the best available clock is selected as the source of time (the grandmaster clock) for the network and that other clocks in the network are synchronized to the grandmaster.

PTP consists of two parts:

  • The port state machine and best master clock algorithm, which provides a method to determine which ports in the network will run as master (providing time to other clocks to the network), which will run as slaves (receiving time from other clocks in the network), and which will be passive (neither master nor slave).
  • Mechanisms for slave ports to calculate the difference between the time of their own clocks and the time of their master clock. To calculate the differences, PTP uses a delay request/response mechanism and a peer delay mechanism.

The implementation of PTP on Cisco IOS XR software is designed to operate effectively in Telecommunication networks, which are different from the networks for which PTP was originally designed.

PTP is configurable on Gigabit Ethernet interfaces and link aggregation group (LAG) Ethernet bundle interfaces. PTP is not configurable on LAG Ethernet subinterfaces.

PTP Transport Media

PTP is supported over the following transport media:

  • UDP over IPv4

PTP Messages

PTP supports the following message types:

  • Sync
  • Delay-request
  • Follow-up
  • Delay-Response
  • Announce
  • Signaling
  • Management

Unicast and Multicast Messages

PTP supports the following options for unicast and multicast:

  • Unicast mode: In this mode, all PTP messages are sent as unicast messages. This is the default behavior.
  • Mixed or Multicast mode: In this mode, Announce and Sync messages are sent as multicast messages, while Signaling, Delay-Request and Delay-Response messages are only sent unicast.

Frequency and Time Selection

The selection of the source to use to synchronize the backplane clock frequency and time is made by frequency synchronization, and is outside of the scope of PTP. The Announce, Sync and Delay-Request frequencies must be the same on the master and slave.

Delay-Response Mechanism

The Delay Request-Response Mechanism, defined in section 11.3 of IEEE Std 1588-2008, is a mechanism which allows a slave ports to estimate to a good degree of accuracy the difference between its own clock-time, and the clock-time of its master. The following options are supported:

  • One-step mechanism - The timestamp for the Sync message is sent in the Sync message itself.
  • Two-step mechanism - The timestamp for the Sync message in a later Follow-Up message.

When running a port in Slave state, a router can send Delay-Request messages and handle incoming Sync, Follow-Up and Delay-Response messages. The timeout periods for both Sync and Delay-Response messages are individually configurable.

PTP Interface and Profile Configuration

If a global PTP profile is attached to an interface, its values are used as the default settings for that interface. If additional settings are configured under the interface itself, these override the defaults in the profile. If no profile is attached to an interface, the configuration on the interface is used to determine the PTP settings for the interface.

You can use either of the following approaches when configuring PTP:

  • Create a profile (or multiple profiles) containing all the default settings to use on all PTP interfaces. Override any settings that differ for particular interfaces by using the interface configuration under the interfaces themselves.
  • Configure all settings separately for each interface, without using any global profiles. Use this approach if the interfaces do not have consistent settings, or if you are configuring only a small number of PTP interfaces.

PTP Hybrid Mode

Your router allows the ability to select separate sources for frequency and time-of-day (ToD). Frequency selection can be between any source of frequency available to the router, such as: BITS, GPS, SyncE or IEEE 1588 PTP. The ToD selection is between the source selected for frequency and PTP, if available. This is known as hybrid mode, where a physical frequency source (BITS or SyncE) is used to provide frequency synchronization, while PTP is used to provide ToD synchronization.

Frequency selection uses the algorithm described in ITU-T recommendation G.871, and is described in the Configuring Frequency Synchronization module in this document. The ToD selection is controlled using the time-of-day priority configuration. This configuration is found under the source interface frequency synchronization configuration mode and under the global PTP configuration mode. It controls the order for which sources are selected for ToD. Values in the range of 1 to 254 are allowed, with lower numbers indicating higher priority.

Related References

ITU-T Telecom Profile for PTP

Cisco IOS XR software supports the ITU-T Telecom Profile for PTP as defined in ITU-T recommendation G.8265.1. The Telecom Profile is a profile for the IEEE 1588-2008 standard that fulfills the specific frequency-distribution requirements of telecommunications networks. It differs in several key ways from the default behavior defined in the IEEE 1588-2008 standard:

  • Clock advertisement: The Telecom Profile specifies changes to values used in Announce messages for advertising PTP clocks. The clock class value is used to advertise the quality level of the clock, while other values are not used.
  • Clock Selection: The Telecom Profile specifies an alternate Best Master Clock Algorithm (BMCA) for selecting port states, and selecting between clocks. The Telecom Profile also requires Sync messages (and optionally Delay-Response messages, if required by the implementation) to be received in order to qualify a clock for selection.
  • Port State Decision: As part of the alternate BMCA, the Telecom Profile states that ports are statically configured to be Master or Slave, rather than using an FSM to dynamically set port states.
  • Packet Rates: The Telecom Profile uses packet rates higher than those specified in the IEEE 1588-2008 standard:
    • Sync/Follow-Up Packets: Rates from 128 packets-per-second to 16 seconds-per-packet.
    • Delay-Request/Delay-Response Packets: Rates from 128 packets-per-second to 16 seconds-per-packet.
    • Announce Packets: Rates from 8 packets-per-second to 16 seconds-per-packet.
  • Transport Mechanism: The Telecom Profile restricts the PTP transport mechanism to IPv4.
  • Unicast: The Telecom Profile mandates that all packets should be sent unicast, rather than multicast.
  • Clock Type: The Telecom Profile restricts the supported clock-types to Ordinary Clock (a clock with only a single PTP port). For a Telecom Profile slave, meaning that all PTP ports on a single device operate independently of each other, functions such as clock selection operate outside of the context of each Ordinary Clock within the system.
  • Domain Numbers: The Telecom Profile restricts the range of domain numbers to between 4 and 23, with the default being 4.
  • Port Numbers: The Telecom Profile dictates that all port numbers for PTP ports are 1, as all clocks within a Telecom Profile network are ordinary clocks.

Clock Selection for Telecom Profile

The Telecom Profile specifies an alternative algorithm for selecting between different master clocks, based on the quality level (QL) of master clocks and on a local priority given to each master clock.

For a master clock to be eligible for selection under the Telecom Profile, Sync and Delay-Resp messages must be being received reliably. The Telecom Profile defines a condition known as Packet Timing Signal Fail (PTSF)-lossSync, which is raised for master clocks for which a reliable stream of Sync and Delay-Resp is not being received. To track which masters are experiencing PTSF-lossSync, the Cisco IOS XR software requests Sync and Delay-Resp grants for each configured master.

Along with PTSF-lossSync, the Telecom Profile defines PTSF-lossAnnounce, which is raised for masters for which a reliable stream of Announce messages are not being received. As in the IEEE1588 standard, masters for which Announce messages are not being received do not qualify for selection.

The Telecom Profile also defines the PTSF-unusable condition, which is raised for masters for which Announce, Sync and Delay-Resp messages are being received reliably, but which are not usable by the slave for some other (implementation-specific) reason, and thus not eligible for selection. Cisco IOS XR software does not use the PTSF-unusable condition.

The clock-selection telecom-profile global configuration command indicates that the Telecom Profile clock selection algorithm is used.

Telecom Profile Configuration Options

There is no single configuration scenario to enable the Telecom Profile mode. The Cisco IOS XR software provides you the flexibility to configure any or all of the Telecom Profile options. You can force fully compliant behavior using the available options in combination with an existing PTP configuration. Or you can choose to configure certain parts of the Telecom Profile. For example, you can use the Cisco ASR 9000 router as a boundary clock within a Telecom Profile network, or to distribute the time-of-day.

To have a fully compliant Telecom Profile configuration, the following configuration is required:

  • Use the clock-selection telecom-profile and clock-advertisement telecom-profile commands in global configuration mode.
  • Force each PTP port to be either in either master state (do not configure a PTP master table) or slave state (use the port state slave-only command).
  • Use only unicast IPv4 transport. This is the default option.
  • Use the ptp unicast-grant invalid-request deny command for each interface on which PTP is configured.

How to Configure PTP

Configuring Frequency and Quality Settings for PTP

These steps configure frequency and quality settings for PTP:

SUMMARY STEPS

    1.    configure

    2.    frequency synchronization

    3.    quality itu-t option option generation number

    4.    Use one of these commands:

    • end
    • commit


DETAILED STEPS
      Command or Action Purpose
    Step 1 configure


    Example:
    RP/0/RSP0/CPU0:router# configure
     

    Enters global configuration mode.

     
    Step 2 frequency synchronization


    Example:
    RP/0/RSP0/CPU0:router(config)# frequency synchronization
     

    Enters frequency synchronization mode.

     
    Step 3 quality itu-t option option generation number


    Example:
    RP/0/RSP0/CPU0:router(config-freqsync)# quality itu-t 
    option 2 generation 2 
    
     

    Sets ITU-T quality parameters.

     
    Step 4 Use one of these commands:
    • end
    • commit


    Example:
    RP/0/RSP0/CPU0:router(config-freqsync)# end

    or

    RP/0/RSP0/CPU0:router(config-freqsync)# commit
     

    Saves configuration changes.

    • When you issue the end command, the system prompts you to commit changes:
      Uncommitted changes found, commit them
      before exiting(yes/no/cancel)? [cancel]:
      
      • Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode.
      • Entering no exits the configuration session and returns the router to EXEC mode without committing the configuration changes.
      • Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.
    • Use the commit command to save the configuration changes to the running configuration file, and remain within the configuration session.
     

    Configuring Global Profile Settings for PTP

    Use these steps to configure a global configuration profile for a PTP interface. This profile can then be assigned to any interface as required. You can override this configuration for any particular interface using configuration commands in interface PTP configuration mode. See Configuring a PTP Slave Interface or Configuring a PTP Master Interface for more information.

    SUMMARY STEPS

      1.    configure

      2.    ptp

      3.    profile name

      4.    sync frequency rate

      5.    delay-request frequency rate

      6.    Use one of these commands:

      • end
      • commit


    DETAILED STEPS
        Command or Action Purpose
      Step 1 configure


      Example:
      RP/0/RSP0/CPU0:router# configure
       

      Enters global configuration mode.

       
      Step 2 ptp


      Example:
      RP/0/RSP0/CPU0:router(config)# ptp
      
       

      Enters PTP configuration mode.

       
      Step 3 profile name


      Example:
      RP/0/RSP0/CPU0:router(config-ptp)# profile tp64
      
       

      Enters PTP profile configuration mode for the specified profile.

       
      Step 4 sync frequency rate


      Example:
      RP/0/RSP0/CPU0:router(config-ptp-profile)# sync frequency 64
       

      Configures the Sync message frequency for the profile.

       
      Step 5 delay-request frequency rate


      Example:
      RP/0/RSP0/CPU0:router(config-ptp-profile)# delay-request 
      frequency 64
       

      Sets the delay request frequency for the profile.

       
      Step 6 Use one of these commands:
      • end
      • commit


      Example:
      RP/0/RSP0/CPU0:router(config-ptp-profile)# end

      or

      RP/0/RSP0/CPU0:router(config-ptp-profile)# commit
       

      Saves configuration changes.

      • When you issue the end command, the system prompts you to commit changes:
        Uncommitted changes found, commit them
        before exiting(yes/no/cancel)? [cancel]:
        
        • Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode.
        • Entering no exits the configuration session and returns the router to EXEC mode without committing the configuration changes.
        • Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.
      • Use the commit command to save the configuration changes to the running configuration file, and remain within the configuration session.
       

      Configuring a PTP Slave Interface

      Use these steps to configure an interface to be a PTP slave:

      SUMMARY STEPS

        1.    configure

        2.    interface type interface-path-id

        3.    ptp

        4.    profile name

        5.    transport ipv4

        6.    announce timeout timeout

        7.    port state slave-only

        8.    master ipv4 address

        9.    exit

        10.    ipv4 address address mask

        11.    transceiver permit pid all

        12.    Use the commit or end command.

        13.    show run interface value


      DETAILED STEPS
          Command or Action Purpose
        Step 1 configure


        Example:
        RP/0/RSP0/CPU0:router# configure
         

        Enters global configuration mode.

         
        Step 2 interface type interface-path-id


        Example:
        RP/0/RSP0/CPU0:router(config)# interface TenGigE 0/1/0/5
         

        Enters configuration mode for a specified interface. PTP is supported on Gigabit Ethernet and Bundle Ethernet interfaces.

         
        Step 3 ptp


        Example:
        RP/0/RSP0/CPU0:router(config-if)# ptp
         

        Enters PTP configuration mode for the interface.

         
        Step 4 profile name


        Example:
        RP/0/RSP0/CPU0:router(config-if-ptp)# profile tp64
         

        Specifies a previously-defined configuration profile to use for this interface. See Configuring Global Profile Settings for PTP for more information. Any additional commands entered in PTP interface configuration mode override settings in this profile.

         
        Step 5 transport ipv4


        Example:
        RP/0/RSP0/CPU0:router(config-if-ptp)# transport ipv4
         

        Specifies that IPv4 is the transport mode for PTP messages.

         
        Step 6 announce timeout timeout


        Example:
        RP/0/RSP0/CPU0:router(config-if-ptp)# announce timeout 2
         

        Sets the timeout for PTP announce messages.

         
        Step 7 port state slave-only


        Example:
        RP/0/RSP0/CPU0:router(config-if-ptp)# port state slave-only
         

        Specifies that the port state is for a slave.

         
        Step 8 master ipv4 address


        Example:
        RP/0/RSP0/CPU0:router(config-if-ptp)# master ipv4 192.168.2.1
         

        Specifies the IPv4 address for the PTP master.

         
        Step 9 exit


        Example:
        RP/0/RSP0/CPU0:router(config-if-ptp)# exit
        RP/0/RSP0/CPU0:router(config-if)
         

        Exits PTP interface configuration mode.

         
        Step 10 ipv4 address address mask


        Example:
        RP/0/RSP0/CPU0:router(config-if)# ipv4 address 1.7.1.1 255.255.255.0
         

        Configures the gateway for the interface.

         
        Step 11 transceiver permit pid all


        Example:
        RP/0/RSP0/CPU0:router(config-if)# transceiver permit pid all
         

        Configures the transceiver for the interface.

         
        Step 12 Use the commit or end command.  

        commit—Saves the configuration changes, and remains within the configuration session.

        end—Prompts user to take one of these actions:
        • Yes— Saves configuration changes and exits the configuration session.
        • No—Exits the configuration session without committing the configuration changes.
        • Cancel—Remains in the configuration mode, without committing the configuration changes.
         
        Step 13 show run interface value


        Example:
        RP/0/RSP0/CPU0:router# show run interface tengige0/1/0/5
        
        Fri Aug  3 19:57:14.184 UTC
        interface TenGigE0/1/0/5
         ptp
          profile tp64
          transport ipv4
          port state slave-only
          master ipv4 1.7.1.2
          !
          announce timeout 2
         !
         ipv4 address 1.7.1.1 255.255.255.0
         transceiver permit pid all
        !
         
         

        Displays the running configuration.

         

        Configuring the Clock Interface for a PTP Master

        Use these steps to configure a clock interface for the PTP master:

        SUMMARY STEPS

          1.    configure

          2.    clock-interface sync value location node

          3.    port-parameters dti

          4.    frequency synchronization

          5.    selection input

          6.    priority number

          7.    wait-to-restore number

          8.    ssm disable

          9.    quality receive exact itu-t option number generation number PRS

          10.    Use one of these commands:

          • end
          • commit


        DETAILED STEPS
            Command or Action Purpose
          Step 1 configure


          Example:
          RP/0/RSP0/CPU0:router# configure
           

          Enters global configuration mode.

           
          Step 2 clock-interface sync value location node


          Example:
          RP/0/RSP0/CPU0:router(config)# clock-interface sync 1 
          location 0/RSP0/CPU0 
           

          Enters configuration mode for the specified clock interface.

           
          Step 3 port-parameters dti


          Example:
          RP/0/RSP0/CPU0:router(config-clock-if)# port-parameters dti
          
           

          Configures the port parameters for the clock interface.

           
          Step 4 frequency synchronization


          Example:
           
          RP/0/RSP0/CPU0:router(config-clock-if)# frequency synchronization
          
           

          Enters frequency synchronization mode for the clock interface.

           
          Step 5 selection input


          Example:
          RP/0/RSP0/CPU0:router(config-clk-freqsync)# selection input
          
           

          Configures selection input for the clock interface.

           
          Step 6 priority number


          Example:
          RP/0/RSP0/CPU0:router(config-clk-freqsync)# priority 10
          
           

          Configures priority for the clock interface.

           
          Step 7 wait-to-restore number


          Example:
          RP/0/RSP0/CPU0:router(config-clk-freqsync)# wait-to-restore 0
          
           

          Configures the wait-to-restore time for the clock interface.

           
          Step 8 ssm disable


          Example:
          RP/0/RSP0/CPU0:router(config-clk-freqsync)# ssm disable
          
           

          Disables SSM packets for the clock interface.

           
          Step 9 quality receive exact itu-t option number generation number PRS


          Example:
          RP/0/RSP0/CPU0:router(config-clk-freqsync)# quality receive 
          exact itu-t option 2 generation 2 PRS
          
           

          Configures quality settings for frequency synchronization for the clock interface.

           
          Step 10 Use one of these commands:
          • end
          • commit


          Example:
          RP/0/RSP0/CPU0:router(config-clk-freqsync)# end

          or

          RP/0/RSP0/CPU0:router(config-clk-freqsync)# commit
           

          Saves configuration changes.

          • When you issue the end command, the system prompts you to commit changes:
            Uncommitted changes found, commit them
            before exiting(yes/no/cancel)? [cancel]:
            
            • Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode.
            • Entering no exits the configuration session and returns the router to EXEC mode without committing the configuration changes.
            • Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.
          • Use the commit command to save the configuration changes to the running configuration file, and remain within the configuration session.
           

          Configuring a PTP Master Interface

          Use these steps to configure an interface that acts as a PTP master.

          SUMMARY STEPS

            1.    configure

            2.    interface type interface-path-id

            3.    ptp

            4.    profile name

            5.    transport ipv4

            6.    announce timeout timeout

            7.    exit

            8.    ipv4 address address mask

            9.    transceiver permit pid all

            10.    Use the commit or end command.

            11.    show run interface value


          DETAILED STEPS
              Command or Action Purpose
            Step 1 configure


            Example:
            RP/0/RSP0/CPU0:router# configure
             

            Enters global configuration mode.

             
            Step 2 interface type interface-path-id


            Example:
            RP/0/RSP0/CPU0:router(config)# interface TenGigE 0/1/0/5
             

            Enters configuration mode for a specified interface. PTP is supported on Gigabit Ethernet and Bundle Ethernet interfaces.

            A single member of the bundle is selected on which to send all PTP packets. In the event that this member goes down, another member is selected on which to send all PTP packets.

             
            Step 3 ptp


            Example:
            RP/0/RSP0/CPU0:router(config-if)# ptp
             

            Enters PTP configuration mode for the interface.

             
            Step 4 profile name


            Example:
            RP/0/RSP0/CPU0:router(config-if-ptp)# profile tp64
             

            Specifies a previously-defined configuration profile to use for this interface. See Configuring Global Profile Settings for PTP for more information. Any additional commands entered in PTP interface configuration mode override settings in this profile.

             
            Step 5 transport ipv4


            Example:
            RP/0/RSP0/CPU0:router(config-if-ptp)# transport ipv4
             

            Specifies that IPv4 is the transport mode for PTP messages.

             
            Step 6 announce timeout timeout


            Example:
            RP/0/RSP0/CPU0:router(config-if-ptp)# announce timeout 2
             

            Sets the timeout for PTP announce messages.

             
            Step 7 exit


            Example:
            RP/0/RSP0/CPU0:router(config-if-ptp)# exit
             

            Returns to configuration mode for the interface.

             
            Step 8 ipv4 address address mask


            Example:
            RP/0/RSP0/CPU0:router(config-if)# ipv4 address 1.7.1.2 255.255.255.0
             

            Configures the gateway for the interface.

             
            Step 9 transceiver permit pid all


            Example:
            RP/0/RSP0/CPU0:router(config-if)# transceiver permit pid all
             

            Configures the transceiver for the interface.

             
            Step 10 Use the commit or end command.  

            commit—Saves the configuration changes, and remains within the configuration session.

            end—Prompts user to take one of these actions:
            • Yes— Saves configuration changes and exits the configuration session.
            • No—Exits the configuration session without committing the configuration changes.
            • Cancel—Remains in the configuration mode, without committing the configuration changes.
             
            Step 11 show run interface value


            Example:
            RP/0/RSP0/CPU0:router# show run interface Te0/1/0/5
            Fri Aug  3 13:57:44.366 PST
            interface TenGigE0/5/1/0
             ptp
              profile tp64
              transport ipv4
              announce timeout 2
             !
             ipv4 address 1.7.1.2 255.255.255.0
             transceiver permit pid all
            !
              
             

            Shows the running configuration.

             

            Configuring GPS Settings for the Grand Master Clock

            Use these steps to configure GPS settings for PTP.

            SUMMARY STEPS

              1.    configure

              2.    clock-interface sync port-number location interface-location

              3.    port-parameters

              4.    gps-input tod-format cisco pps-input rs422

              5.    gps-output tod-format cisco pps-output rs422

              6.    exit

              7.    frequency synchronization

              8.    selection input

              9.    priority number

              10.    wait-to-restore number

              11.    ssm disable

              12.    quality receive exact itu-t option option generation number

              13.    Use one of these commands:

              • end
              • commit

              14.    show run interface value


            DETAILED STEPS
                Command or Action Purpose
              Step 1 configure


              Example:
              RP/0/RSP0/CPU0:router# configure
               

              Enters global configuration mode.

               
              Step 2 clock-interface sync port-number location interface-location


              Example:
               
              RP/0/RSP0/CPU0:router(config)# clock-interface 
              sync 2 location 0/RSP0/CPU0 
               

              Enters configuration mode for the clock interface.

               
              Step 3 port-parameters


              Example:
              RP/0/RSP0/CPU0:router(config-clock-if)# port-parameters
               

              Enters configuration mode for the port parameters.

               
              Step 4 gps-input tod-format cisco pps-input rs422


              Example:
              RP/0/RSP0/CPU0:router(config-clk-parms)# gps-input tod-format 
              cisco pps-input rs422 
               

              Configures GPS input parameters.

               
              Step 5 gps-output tod-format cisco pps-output rs422


              Example:
              RP/0/RSP0/CPU0:router(config-clk-parms)# gps-output tod-format 
              cisco pps-output rs422 
               

              Configures GPS output parameters.

               
              Step 6 exit


              Example:
              RP/0/RSP0/CPU0:router(config-clk-parms)# exit
               

              Exits clock port parameter configuration mode.

               
              Step 7 frequency synchronization


              Example:
              RP/0/RSP0/CPU0:router(config-clock-if)# frequency synchronization
               

              Enters frequency synchronization mode for the clock interface.

               
              Step 8 selection input


              Example:
              RP/0/RSP0/CPU0:router(config-clk-freqsync)# selection input
               

              Configures selection input for the clock interface.

               
              Step 9 priority number


              Example:
              RP/0/RSP0/CPU0:router(config-clk-freqsync)# priority 10
              
               

              Configures priority for the clock interface.

               
              Step 10 wait-to-restore number


              Example:
              RP/0/RSP0/CPU0:router(config-clk-freqsync)# wait-to-restore 0
              
               

              Configures the wait-to-restore time for the clock interface.

               
              Step 11 ssm disable


              Example:
              RP/0/RSP0/CPU0:router(config-clk-freqsync)# ssm disable
              
               

              Disables SSM packets for the clock interface.

               
              Step 12 quality receive exact itu-t option option generation number


              Example:
              RP/0/RSP0/CPU0:router(config-clk-freqsync)# quality receive 
              exact itu-t option 2 generation 2 PRS  
               

              Configures ITU-T quality parameters.

               
              Step 13 Use one of these commands:
              • end
              • commit


              Example:
              RP/0/RSP0/CPU0:router(config-clk-freqsync)# end

              or

              RP/0/RSP0/CPU0:router(config-clk-freqsync)# commit
               

              Saves configuration changes.

              • When you issue the end command, the system prompts you to commit changes:
                Uncommitted changes found, commit them
                before exiting(yes/no/cancel)? [cancel]:
                  
                • Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode.
                • Entering no exits the configuration session and returns the router to EXEC mode without committing the configuration changes.
                • Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.
              • Use the commit command to save the configuration changes to the running configuration file, and remain within the configuration session.
               
              Step 14 show run interface value


              Example:
              RP/0/RSP0/CPU0:router# show run interface Te0/1/0/5
              
              Fri Aug  3 13:57:44.366 PST
              interface TenGigE0/5/1/0
               ptp
                profile tp64
                transport ipv4
                announce timeout 2
               !
               ipv4 address 1.7.1.2 255.255.255.0
               transceiver permit pid all
              !
                
               

              Shows the running configuration.

               

              Configuring PTP Hybrid Mode

              You configure hybrid mode by selecting PTP for the time-of-day (ToD) and another source for the frequency. This task summaries the hybrid configuration. Refer to the other PTP configuration modules for more detailed information regarding the PTP configurations. Refer to the Configuring Ethernet Interfaces module in Cisco ASR 9000 Series Aggregation Services Router Interface and Hardware Component Configuration Guide for more information regarding SyncE configurations.

              SUMMARY STEPS

                1.    Enable Frequency Synchronization.

                2.    Configure a SyncE input.

                3.    Enable PTP on the router.

                4.    Configure a PTP interface on the router.


              DETAILED STEPS
                  Command or Action Purpose
                Step 1 Enable Frequency Synchronization.

                Example:
                RP/0/RSP0/CPU0:router(config)# frequency synchronization
                RP/0/RSP0/CPU0:router(config)# commit
                  
                 

                Enables frequency synchronization on the router.

                 
                Step 2 Configure a SyncE input.

                Example:
                RP/0/RSP0/CPU0:router(config)# interface GigabitEthernet 0/1/0/0
                RP/0/RSP0/CPU0:router(config-if)# frequency synchronization
                RP/0/RSP0/CPU0:router(config-if-freqsync)# selection input
                RP/0/RSP0/CPU0:router(config-if-freqsync)# time-of-day-priority 100
                RP/0/RSP0/CPU0:router(config-if-freqsync)# commit
                  
                 

                Configures an interface to be a SyncE input. It is also possible to configure BITS or SONET/SDH as the frequency source. The time-of-day-priority setting specifies that SyncE is used as the ToD source if no source has a lower priority.

                 
                Step 3 Enable PTP on the router.

                Example:
                RP/0/RSP0/CPU0:router(config)# ptp
                RP/0/RSP0/CPU0:router(config-ptp)# time-of-day priority 1
                RP/0/RSP0/CPU0:router(config)# commit
                  
                 

                Enables PTP on the router and specifies that PTP is the ToD source if it is available. Values for the ToD priority can range from 1 (highest priority) to 254 (lowest priority).

                 
                Step 4 Configure a PTP interface on the router.

                Example:
                RP/0/RSP0/CPU0:router(config)# interface gigabitEthernet 0/1/0/1
                RP/0/RSP0/CPU0:router(config-if)# ipv4 address 10.0.0.1/24
                RP/0/RSP0/CPU0:router(config-if)# ptp
                RP/0/RSP0/CPU0:router(config-if-ptp)# master ipv4 10.0.0.2
                RP/0/RSP0/CPU0:router(config-if-ptp)# commit
                  
                 

                Enables a PTP interface on the router and specifies an interface as the PTP master.

                 

                How to Configure PTP Telecom Profile

                Configuring an Interface for the PTP Telecom Profile

                This task details the interface settings that are applicable to the ITU-T Telecom Profile.


                Note


                It is also possible to make these definitions within a global PTP profile and attach them to the interface using the profile command in PTP interface configuration mode.


                SUMMARY STEPS

                  1.    configure

                  2.    interface type interface-path-id

                  3.    ptp

                  4.    profile name

                  5.    sync frequency rate

                  6.    delay-request frequency rate

                  7.    announce grant-duration duration

                  8.    sync grant-duration duration

                  9.    delay-response grant-duration duration

                  10.    sync timeout timeout

                  11.    delay-response timeout timeout

                  12.    unicast-grant invalid-request {reduce | deny}

                  13.    master ipv4 ip-address

                  14.    clock-class class

                  15.    Use one of these commands:

                  • end
                  • commit


                DETAILED STEPS
                    Command or Action Purpose
                  Step 1 configure


                  Example:
                  RP/0/RSP0/CPU0:router# configure
                   

                  Enters global configuration mode.

                   
                  Step 2 interface type interface-path-id


                  Example:
                  RP/0/RSP0/CPU0:router(config)# interface gigabitethernet 
                  0/1/0/1
                   

                  Enters interface configuration mode for the specified interface.

                   
                  Step 3 ptp


                  Example:
                  RP/0/RSP0/CPU0:router(config-if)# ptp
                  
                   

                  Enters PTP interface configuration mode.

                   
                  Step 4 profile name


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# profile tele64
                  
                   

                  Attaches a previously-defined profile to this interface. Profiles are defined in global PTP configuration mode.

                  Note   

                  Any configurations made in PTP interface configuration mode override the global profile settings.

                   
                  Step 5 sync frequency rate


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# sync frequency 128
                   

                  Configures the interval between sending Sync messages. Valid values are 2, 4, 8, 16, 32, 64 or 128.

                   
                  Step 6 delay-request frequency rate


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# delay-request 
                  frequency 128
                   

                  Configures the interval between sending Delay Request messages. Valid values are 2, 4, 8, 16, 32, 64 or 128.

                   
                  Step 7 announce grant-duration duration


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# announce 
                  grant-duration 120
                   

                  Specifies the Announce message grant duration, in seconds. Values can range from 60 to 1000. If the port is in slave state, this is the length of grant that is requested. If the port is in master mode, this is the maximum grant allowed.

                   
                  Step 8 sync grant-duration duration


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# sync grant-duration 120
                   

                  Specifies the Sync message grant duration, in seconds. Values can range from 60 to 1000. If the port is in slave state, this is the length of grant requested. If the port is in master mode, this is the maximum grant allowed.

                   
                  Step 9 delay-response grant-duration duration


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# delay-response 
                  grant-duration 120
                   

                  Specifies the Delay Response message grant duration in seconds. Values can range from 60 to 1000. If the port is in slave state, this is the length of the grant requested. If the port is in master mode, this is the maximum grant allowed.

                   
                  Step 10 sync timeout timeout


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# sync timeout 120
                   

                  Specifies the length of time in micro seconds that Sync messages are not received before a PTSF-lossSync is raised. Values can range from 100 to 10000.

                   
                  Step 11 delay-response timeout timeout


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# delay-response 
                  timeout 120
                   

                  Specifies the length of time, in micro seconds, that Delay Response messages are not received before a PTSF-lossSync is raised. Values can range from 100 to 10000.

                   
                  Step 12 unicast-grant invalid-request {reduce | deny}


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# unicast-grant 
                  invalid-request reduce
                   

                  Specifies whether unicast grant requests with unacceptable parameters are denied or granted with reduced parameters.

                   
                  Step 13 master ipv4 ip-address


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp)# master ipv4 
                  192.168.2.1
                   

                  Specifies the IPv4 address for the PTP master that the interface should listen to. Multiple masters can be configured.

                   
                  Step 14 clock-class class


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp-master)# clock-class 2
                   

                  Overrides the clock class received in announce messages from this master. Values can range from 0 to 255.

                   
                  Step 15 Use one of these commands:
                  • end
                  • commit


                  Example:
                  RP/0/RSP0/CPU0:router(config-if-ptp-master)# end

                  or

                  RP/0/RSP0/CPU0:router(config-if-ptp-master)# commit
                   

                  Saves configuration changes.

                  • When you issue the end command, the system prompts you to commit changes:
                    Uncommitted changes found, commit them
                    before exiting(yes/no/cancel)? [cancel]:
                    
                    • Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode.
                    • Entering no exits the configuration session and returns the router to EXEC mode without committing the configuration changes.
                    • Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.
                  • Use the commit command to save the configuration changes to the running configuration file, and remain within the configuration session.
                   

                  Configuring PTP Clock Settings for the Telecom Profile

                  Perform this task to configure clock settings to be consistent with the ITU-T Telecom Profile for Frequency (G.8265.1).

                  SUMMARY STEPS

                    1.    configure

                    2.    ptp

                    3.    clock

                    4.    timescale

                    5.    time-source source

                    6.    exit

                    7.    clock-selection telecom-profile

                    8.    clock-advertisement telecom-profile

                    9.    Use one of these commands:

                    • end
                    • commit


                  DETAILED STEPS
                      Command or Action Purpose
                    Step 1 configure


                    Example:
                    RP/0/RSP0/CPU0:router# configure
                     

                    Enters global configuration mode.

                     
                    Step 2 ptp


                    Example:
                    RP/0/RSP0/CPU0:router(config)# ptp
                    RP/0/RSP0/CPU0:router(config-ptp)# 
                     

                    Enters PTP configuration mode.

                     
                    Step 3 clock


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp)# clock
                    RP/0/RSP0/CPU0:router(config-ptp-clock)# 
                     

                    Enters PTP clock configuration mode.

                     
                    Step 4 timescale


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp-clock)# timescale ptp
                     

                    Sets the timescale to be PTP.

                     
                    Step 5 time-source source


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp-clock)# time-source ptp
                     

                    Sets the time source advertised in Announce messages. Valid options are: atomic-clock, GPS, hand-set, internal-oscillator, NTP, other, PTP, terrestrial-radio.

                     
                    Step 6 exit


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp-clock)# exit
                     

                    Exits PTP clock configuration mode.

                     
                    Step 7 clock-selection telecom-profile


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp)# clock-selection telecom-profile
                     

                    Specifies that the clock selection behavior, i.e, the best master clock algorithm in use, follows the telecom profile for frequency (ITU-T G.8265.1).

                     
                    Step 8 clock-advertisement telecom-profile


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp)# clock-advertisement telecom-profile
                     

                    Specifies that the parameters used in Announce messages follows the Telecom profile for frequency (ITU-T G.8265.1).

                     
                    Step 9 Use one of these commands:
                    • end
                    • commit


                    Example:
                    RP/0/RSP0/CPU0:router(config-ptp)# end

                    or

                    RP/0/RSP0/CPU0:router(config-ptp)# commit
                     

                    Saves configuration changes.

                    • When you issue the end command, the system prompts you to commit changes:
                      Uncommitted changes found, commit them
                      before exiting(yes/no/cancel)? [cancel]:
                      
                      • Entering yes saves configuration changes to the running configuration file, exits the configuration session, and returns the router to EXEC mode.
                      • Entering no exits the configuration session and returns the router to EXEC mode without committing the configuration changes.
                      • Entering cancel leaves the router in the current configuration session without exiting or committing the configuration changes.
                    • Use the commit command to save the configuration changes to the running configuration file, and remain within the configuration session.
                     
                    What to Do Next

                    Configure your interface to be consistent with the ITU-T Telecom Profile.

                    Configuration Examples for Implementing PTP

                    Configuring Slave Settings: Example

                    The following example shows a PTP slave configuration .

                     ptp
                      profile tp64
                      transport ipv4
                      port state slave-only
                      master ipv4 1.7.1.2
                      !
                      announce timeout 2
                     !
                     ipv4 address 1.7.1.1 255.255.255.0
                     transceiver permit pid all
                    !
                    
                      

                    Configuring Master Settings: Example

                    This example shows a PTP master configuration .

                     ptp
                      profile tp64
                      transport ipv4
                      announce timeout 2
                     !
                     ipv4 address 1.7.1.2 255.255.255.0
                     transceiver permit pid all
                    !
                      

                    Configuring GPS Settings: Example

                    This example shows the GPS configuration for PTP.

                    clock-interface sync 2 location 0/RSP0/CPU0
                     port-parameters
                      gps-input tod-format cisco pps-input rs422
                     !
                     frequency synchronization
                      selection input
                      priority 2
                      wait-to-restore 0
                      ssm disable
                      quality receive exact itu-t option 2 generation 2 PRS
                     !
                    !
                      

                    PTP Hybrid Mode: Example

                    This example shows the configuration of PTP hybrid mode:

                    ptp
                     time-of-day priority 10
                     !
                    interface GigabitEthernet0/1/1/0
                     ptp
                      transport ipv4
                      port state slave-only
                      master ipv4 192.168.52.38
                      !
                      sync frequency 64
                      announce timeout 2
                      delay-request frequency 64
                     !
                    interface GigabitEthernet 0/1/0/1
                     ipv4 address 192.168.52.41 255.255.255.0
                     speed 100
                     frequency synchronization
                      selection input
                      priority 10
                      wait-to-restore 0
                      ssm disable
                      time-of-day-priority 100
                     !
                     transceiver permit pid all
                      

                    This example shows the output from the show frequency synchronization command:

                    RP/0/RSP0/CPU0:router# show frequency synchronization selection
                    
                    Node 0/RSP0/CPU0:
                    ==============
                    Selection point: T0-SEL-B (3 inputs, 1 selected)
                      Last programmed 18h30m ago, and selection made 4h30m ago
                      Next selection points
                        SPA scoped    : None
                        Node scoped   : T4-SEL-C CHASSIS-TOD-SEL
                        Chassis scoped: LC_TX_SELECT
                        Router scoped : None
                      Uses frequency selection
                      Used for local line interface output
                      S  Input                     Last Selection Point         QL  Pri  Status
                      == ========================  ========================  =====  ===  ===========
                      1  GigabitEthernet0/1/1/0    0/1/CPU0 SPA_RXMUX 1        STU   10  Locked     
                         PTP [0/RSP0/CPU0]         n/a                        ST3E  100  Available  
                         Internal0 [0/RSP0/CPU0]   n/a                        ST3E  255  Available  
                    
                    
                    Selection point: CHASSIS-TOD-SEL (2 inputs, 1 selected)
                      Last programmed 18h30m ago, and selection made 4h30m ago
                      Next selection points
                        SPA scoped    : None
                        Node scoped   : None
                        Chassis scoped: None
                        Router scoped : None
                      Uses time-of-day selection
                      S  Input                     Last Selection Point      Pri  Time  Status
                      == ========================  ========================  ===  ====  ===========
                      1  PTP [0/RSP0/CPU0]         n/a                        10  Yes   Available  
                         GigabitEthernet0/1/1/0    0/RSP0/CPU0 T0-SEL-B 1     10  No    Available 
                      

                    Additional References

                    The following sections provide references related to implementing PTP on Cisco IOS XR software.

                    Related Documents

                    Related Topic

                    Document Title

                    Cisco IOS XR PTP commands

                    PTP Commands module of Cisco ASR 9000 Series Aggregation Services Router System Management Command Reference

                    Cisco IOS XR SyncE commands

                    Frequency Synchronization Commands module of Cisco ASR 9000 Series Aggregation Services Router System Management Command Reference

                    Cisco IOS XR SyncE configuration information

                    Configuring Ethernet Interfaces module of Cisco ASR 9000 Series Aggregation Services Router Interface and Hardware Component Configuration Guide

                    Information about getting started with Cisco IOS XR Software

                    Cisco ASR 9000 Series Aggregation Services Router Getting Started Guide

                    Cisco IOS XR master command index

                    Cisco ASR 9000 Series Aggregation Services Router Commands Master List

                    Information about user groups and task IDs

                    Configuring AAA Services on the Cisco ASR 9000 Series Router module of Cisco ASR 9000 Series Aggregation Services Router System Security Configuration Guide

                    Standards

                    Standards

                    Title

                    No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.

                    MIBs

                    MIBs

                    MIBs Link

                    To locate and download MIBs using Cisco IOS XR software, use the Cisco MIB Locator found at the following URL and choose a platform under the Cisco Access Products menu: http:/​/​cisco.com/​public/​sw-center/​netmgmt/​cmtk/​mibs.shtml

                    RFCs

                    RFCs

                    Title

                    RFC 1588

                    Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control Systems, 2008

                    Technical Assistance

                    Description

                    Link

                    The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

                    http:/​/​www.cisco.com/​cisco/​web/​support/​index.html