Configuring PCMM Record-Keeping Server Plug-Ins (SRC CLI)

Use the following configuration statements to configure an RKS plug-in.

shared sae configuration plug-ins name name pcmm-rks {load-balancing-mode (failover | roundRobin);
failback-timer failback-timer;
retry-interval retry-interval ;
maximum-queue-length maximum-queue-length ;
bind-address bind-address ;
udp-port udp-port ;
feid-mso-data feid-mso-data ;
feid-mso-domain-name feid-mso-domain-name ;
trusted-element;
default-peer default-peer ;
}

To configure an RKS plug-in:

  1. From configuration mode, access the configuration statements for RKS plug-ins. In this sample procedure, west-region is the name of the SAE group, and rksPlugin is the name of the plug-in.
    user@host# edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks
  2. Specify the mode for load-balancing RKSs.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set load-balancing-mode (failover | roundRobin)
  3. Specify if and when the SAE attempts to fail back to the default peer.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set failback-timer failback-timer
  4. Specify the time the SAE waits for a response from an RKS before it resends the packet.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set retry-interval retry-interval
  5. Specify the maximum number of unacknowledged messages that the plug-in receives from the RKS before it discards new messages.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set maximum-queue-length maximum-queue-length
  6. (Optional) Specify the source IP address that the plug-in uses to communicate with the RKS.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set bind-address bind-address
  7. (Optional) Specify the source UDP port or a pool of ports that the plug-in uses to communicate with the RKS.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set udp-port udp-port
  8. (Optional) Specify the multiple service operator (MSO)—defined data in the financial entity ID (FEID) attribute, which is included in event messages.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set feid-mso-data feid-mso-data
  9. (Optional) Specify the MSO domain name in the FEID attribute that uniquely identifies the MSO for billing and settlement purposes.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set feid-mso-domain-name feid-mso-domain-name
  10. (Optional) When the SAE is running as a policy server—which means that the SAE sends event messages directly to the RKS—enable the SAE as a trusted network element.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set trusted-element
  11. Specify the name of the primary RKS peer to which the SAE sends accounting packets.

    See Configuring Record-Keeping Server Peers for Plug-Ins (SRC CLI).

    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks] user@host# set default-peer default-peer
  12. (Optional) Verify your RKS plug-in configuration.
    [edit shared sae group west-region configuration plug-ins name rksPlugin pcmm-rks]
    user@host> show 
    load-balancing-mode failover;
    failback-timer -1;
    retry-interval 3000;
    maximum-queue-length 10000;
    feid-mso-domain-name abcd.com;
    trusted-element;
    default-peer radius01;
  13. (Optional) Specify an RKS plug-in for specific CMTS devices.

    See Configuring CMTS-Specific RKS Plug-Ins (SRC CLI).

Related Documentation