226 | Cisco Systems OL-15491-01 instruction

Appendix A CSG2 Command Reference

retcode

Command History	Release	Modification
	12.4(11)MD	This command was migrated from CSG1.
		Changes from CSG1: None.

	12.4(15)MD	The ftp and sip keywords were added.

Usage Guidelines

Examples

The CSG2 supports return code-based refunding for all protocols except RTSP.

The return codes are protocol-specific.

For IMAP, keep in mind the following considerations:

•Only return code 554 is used. Return code 554 is used when a transaction ending in an IMAP tagged response was not flagged OK.

•The CSG2 does not support refunding for IMAP. If configured, refunding for IMAP has no effect.

The following example shows how to specify ranges of application return codes:

ip csg refund COMPANY-REFUND retcode http 500 509 retcode sip 300 999 retcode wap 0x44 0x50

Related Commands	Command	Description
	flags	Specifies IP, TCP, or wireless application protocol (WAP) flag bit
		masks and values for CSG2 Prepaid Error Reimbursement.

	ip csg refund	Specifies the CSG2 refund policy to apply to the various services,
		and enters CSG2 refund configuration mode.

	Cisco Content Services Gateway - 2nd Generation Release 2.0 Installation and Configuration Guide
A-226	OL-15491-01

Image 226

Cisco Systems OL-15491-01 appendix Masks and values for CSG2 Prepaid Error Reimbursement, 226

Contents

CSG2 Command Reference Appendix a CSG2 Command Reference Appendix a CSG2 Command Reference Appendix a CSG2 Command Reference Appendix a CSG2 Command Reference Accounting Command DescriptionEnters CSG2 policy configuration mode Release Modification Activation Syntax Description Defaults Command ModesActivation automatic user-profile No activation Ip csg service Related Commands DescriptionConfiguration mode Aoc append url No aoc append url Aoc enableAoc append url Aoc confirm Aoc confirm token No aoc confirm Aoc confirmToken Ip csg service Movies aoc enable Aoc confirm ?CSGAOCOK Aoc append url Aoc enable Aoc enableAoc enable No aoc enable Usage Guidelines Examples Command Description Defaults Command Modes Basis Ip csg service Movies Basis fixed Ip csg service Offnet basis second Meter include imap Meter exclude svc-idleMeter increment Block No block Ip csg contentBlock Parse length Usage Guidelines Examples Related Commands Command History Release ModificationClass User Clear ip csgSyntax Description All IP address 12.411MD This command was introduced12.415MD The ftp keyword was added Show ip csg Clear ip iscsi statistics Command Modes Command HistoryClear ip iscsi statistics ReleaseModification Following example clears RSM-related statistics Clear record-storage-module statsClear record-storage-module stats Clear record-storage-module stats Client-group CSG2 content Next-hop Ip csg content MoviesMode Defines a next-hop IP address CSG2 service configuration Content CSG2 serviceDefault weight-valueis 1 quadran You must configure a policy before configuring this command CSG2 policy configuration mode Debug ip csg Imap Gtp quota-serverHttp detail Interm Session event Service detailService ha Session state detail Replicate Statistics Pod Entries user idleEntries user idle duration pod no entries user idle Billing to entries user idle Ip csg billing Ip csg radius pod timeoutService Ip csg entries user idle Wap FlagsTcp Mask Appendix a CSG2 Command Reference Flags Ip csg refund Enters CSG2 refund configuration modeRefunds quota for Prepaid Error Reimbursement Retcode CSG2 content configuration Idle CSG2 contentDefault idle duration is 300 seconds 5 minutes Idle duration no idle duration Sets the pending connection timeout Idle CSG2 serviceService with no subscriber sessions Pending Idle CSG2 service Ip csg service Movies Idle Idle CSG2 content Idle content connection Default value is no inservice Inservice CSG2 contentInservice No inservice Detects an error, the command fails No ip any ip-address Ip CSG2 contentAny Command Modes Command History Usage Guidelines Examples Ip csg content Moviescomedy Ip 172.18.45.0/24 tcp Ip csg iscsi drain packet Ip csg iscsi drain delayIp iSCSI Ip csg iscsi profile Name iSCSI Ip iscsi target-profilePort iSCSI No ip csg billing billing-plan-name Ip csg billingIp csg billing billing-plan-name Entries user idle Syntax Description Defaults Command Modes Command History Ip csg bma Ip csg bma local-port Ip csg bma activateIp csg bma keepalive Ip csg bma messages Ip csg bma activate Sticky seconds Related Commands Description Ip csg bma activate 2 sticky Ip csg ipc keepalive Ip csg bma keepaliveIp csg bma Ip csg psd keepalive Ip csg bma local-port Quota-server local-port command, respectivelyCsg bma command Ip csg bma local-port port-number No ip csg bma local-port Cisco Persistent Storage Device PSD CSG2 accounting service A1Ip csg psd local-port Ip csg bma local-port Ip csg bma messages number no ip csg bma messages 12.411MD This command was migrated from CSG1Ip csg bma messages CSG2 buffers up to 10000 GTP’ messages Ip csg psd margin Ip csg psd drain delayIp csg psd drain packet Ip csg quota-server messages Ip csg bma retransmit number-of-seconds Ip csg bma retransmitNo ip csg bma retransmit Packet Ip csg bma retriesNumber-of-retries Ip csg psd retries Ip csg ipc retriesIp csg quota-server retries Ip csg bma window Min auto Match header Ip csg case-sensitiveIp csg case-sensitive No ip csg case-sensitive Match method Ip csg content Ip csg content content-name No ip csg content content-name Block Subscriber-iphttp-headerforwarded-for Vlan CSG2 content VrfSubscriber-iphttp-headerforwarded-for Server Ip csg databaseNo ip csg database Ip csg database 10.1.2.3 11111 Ip csg entries fragment Default idle duration is 5 secondsDefault maximum number of entries is Ip csg database Ip csg entries user profile Ip csg entries session user max Ip csg entries session user max Server that answers user ID queries Command Description Packet of Disconnect message when an entry idles out Ip csg entries user idle Defines the maximum number of entries in the CSG2 fragment Ip csg entries fragmentDatabase, or how long the CSG2 is to retain the entries Ip csg entries user max entries No ip csg entries user max 12.411MD This command was introducedIp csg entries user max Ip csg entries user max Related Commands Description Ip csg entries user profile Ip csg database Server that answers user ID queries CommandDescriptionIp csg entries user profile radius pass Never Ip csg ipc crashdumpTolerance number-of-seconds Ip csg ipc keepalive number-of-seconds Default value is 8 secondsIp csg ipc keepalive No ip csg ipc keepalive Ip csg ipc retransmit number-of-seconds Default value is 4 secondIp csg ipc retransmit No ip csg ipc retransmit Ip csg ipc retries number-of-retries Ip csg ipc retriesNo ip csg ipc retries Ip csg iscsi drain delay Ip csg iscsi drain packet Target to be used as backup storage for the CSG2 ISCSI configuration mode No ip csg iscsi profile Ip csg iscsi profileIp csg iscsi profile target-profile-name No iSCSI target is specified Ip csg map map-name No ip csg map map-name Ip csg mapMatch header Match method Match url Map Ip csg case-sensitiveMatch patterns as case-sensitive Policy Ip csg mode single-tp Ip csg mode single-tpCommand No ip csg mode single-tp Ip csg policy policy-name No ip csg policy policy-name Ip csg policyAccounting Map Ip csg map Enters CSG2 map configuration modeAccounting Ip csg policy Moviescomedy Ip csg psd Ip csg psd retransmit Tunneling protocol prime GTP’ messages, beyond the sizeBuffer for the Cisco Persistent Storage Device PSD Ip csg psd window Ip csg psd drain delay number-of-seconds Ip csg psd drain delayNo ip csg psd drain delay Cisco Persistent Storage Device PSD when the Billing Ip csg psd drain packet No ip csg psd keepalive Ip csg psd keepaliveIp csg psd keepalive number-of-seconds Defines the Interprocessor Communication IPC keepalive time Ip csg psd local-port port-number No ip csg psd local-port Csg psd commandIp csg psd local-port Local-port Related Commands Description Ip csg psd margin number no ip csg psd margin Configures a Cisco Persistent Storage Device PSDIp csg psd margin Can buffer for all Billing Mediation Agents BMAs No ip csg psd retransmit Ip csg psd retransmitIp csg psd retransmit number-of-seconds Defines the Interprocessor Communication IPC retransmit Discarding it the initial attempt plus four retries Following example shows how to allow two PSD retriesIp csg psd retries Ip csg psd retries Defines the maximum number of Billing Mediation Agent BMA Ip csg psd window Defines the Billing Mediation Agent BMA transmit window size Syntax Description Defaults Ip csg quota-server Ip csg quota-server retransmit Ip csg quota-server reassignIp csg quota-server window 100 Default value is Global configurationIp csg quota-server activate Ip csg quota-server activate For subscribers Ip csg quota-server keepalive101 1024 to Ip csg quota-server local-portQuota-server local-port 102 For subscribers Following example configures quota server local portBilling Mediation Agent BMA 103 104 Ip csg quota-server messagesIp csg quota-server messages Ip csg quota-server reassign 105 Ip csg quota-server retransmit 106 107 Is 1 to 65535. The default value isIp csg quota-server retries Ip csg quota-server retries 108 As the minimum window Ip csg quota-server windowServer transmit window automatically. The CSG2 keeps track 109 Size for the CSG2 110 No ip csg radius ack error parse Ip csg radius ack error parse111 112 No ip csg radius ack error user Ip csg radius ack error user113 Accounting Interim Request when it encounters a Radius Related Commands Command DescriptionIp csg radius ack error parse Parse error condition No ip csg radius correlation Ip csg radius correlationIp csg radius correlation Csgusersessioncorrelator=string 116 Specifies a Radius key Ip csg radius endpointKey 117 Endpoint 118 Ip csg radius userid Ip csg radius monitorNas 119 Ip csg radius handoff Radius handoff is disabledCommand History Usage Guidelines Release Modification Ip csg radius handoff duration No ip csg radius handoff Session-id Ip csg radius start restart121 Ip csg radius monitor Optional Specifies a Radius key Ip csg radius monitor nas 12.415MD This command was introducedNetwork Access Server NAS 123 124 Ip csg radius monitor nasIp csg radius monitor nas 1.2.3.4 vrf Nastable Specified rate Default rate is 1000 User Table entry deletions per secondIp csg radius on-off purge 125 3gpp Ip csg radius pod attributeVsa 126 Between retransmissions Following example shows how to specify Radius attributes 44Key to use in calculating the Authenticator 127 Possible values are 0 Ip csg radius pod nasExample, write memory 128 Message and sent to the NAS in the PoD Nas129 Default number of retransmits is 3 retransmits Ip csg radius pod timeoutDefault timeout is 5 seconds Command History Examples Release Modification Ip csg radius proxy 131 Csg-source-address is set to csg-address 132 Table table-namekeyword and argument were removed Configuration mode for this command changed from module CSGArguments were added Csg-source-address 134 Ip csg radius reauthorization attribute 135 Ip csg radius reauthorization attribute 26 7778 Ip csg radius reauthorization attributeIp csg radius reauthorization attribute vsa 7777 136 Radius start restart session-id This commandIp csg radius start restart session-id 26 keyword was removed 138 Ip csg radius start restart session-id 139 Ip csg radius stop purgeIp csg radius stop purge 140 Calling-Station-Id Ip csg radius useridUser-Name 141 142 Combined http Ip csg records formatVariable Combined wap Ip csg redirect 144 Following example shows how to configure CSG2 redirects 145 Ip csg refund For CSG2 Prepaid Error ReimbursementFor Prepaid Error Reimbursement Flags Replication is not enabled Ip csg replicate Content servers on the standby system 148 Ip csg report smtp rfc2822 Ip csg report http headerIp csg report radius attribute 149 150 No Radius attributes are copied into CDRs Ip csg report radius attribute151 Ip csg report usage Ip csg report http header152 Ip csg report wap actual-pdu Ip csg report smtp rfc2822Ip csg report smtp rfc2822 No ip csg report smtp rfc2822 153 Bytes ip Defaults Command Modes Command History Usage GuidelinesIp csg report usage Seconds Start message into call detail records CDRs 155 Ip csg report wap actual-pdu 156 Activation Aoc append url Aoc confirm Aoc enable Ip csg serviceIp csg service service-name No ip csg service service-name 157 URL-rewriting ServiceActivation Basis 159 Bma Ip csg snmp timerSnmp-server enable traps csg Psd Ip csg subscriber No ip csg subscriber Command Modes Interface configurationIp csg subscriber Interface is not a CSG2 subscriber interface 162 Specifies a service class valueIp csg transport-type assign Ip csg transport-type assign 1.2.3.4 Ip iSCSI Ip iscsi target-profileTarget-profile-name Name of the iSCSI profile 163 164 Map map-name no map map-name CSG2 policy configurationMap Header-map Url-map 166 Match header CSG2 map configuration167 Zero or more characters Match header host1 *.2.*.44Convention Description Zero or one character \character 169 Case-sensitive 170 Method-name Method to be matched. Valid methods are Match methodMatch method method-name No match method method-name Match method get 172 As case-sensitive 173 Match url http//url-string Syntax Description Command Modes Command HistoryMatch url pattern No match url pattern HTTP//url-string 175 176 177 Ip csg map Movies Ip csg map Images Match url *.gifjpg Meter exclude control sip no meter exclude control sip Meter exclude control sip178 Beginning of a service when the service is configured for Specifies which Internet Message Access Protocol Imap bytesAre billed for by the CSG2 when doing prepaid debits Service Duration Billing Meter exclude network-init Meter exclude mms wapMeter exclude control sip Sip 181 Meter exclude network-init sip SERVICE-A serviceIp csg service SERVICE-A Meter exclude network-init sip 182 183 SIP session from the CSG2 usage calculation Meter exclude pause rtspMeter exclude pause rtsp No meter exclude pause rtsp Meter exclude network-init sip 185 Meter exclude svc-idle No meter exclude svc-idle Offnet serviceMeter exclude svc-idle Only basis second is meaningful with meter exclude svc-idle 187 Body only Meter include imapBody header Body other Prepaid debits Ip csg service S1RFC822 189 190 Specify meter increment Meter incrementMeter increment value No meter increment value 191 Ip csg service Offnet Meter increment 192 Meter initial Default quota is 0 quadrans CSG2 service configurationIp csg service Offnet Meter initial Meter initial value no meter initial value 194 Meter minimum value no meter minimum value Default number is 0 quadransMeter minimum Charge is 110 quadrans Ip csg service Offnet Meter minimum 196 Specifies variable or fixed call detail record CDR format Default mode is prepaid CSG2 billing configurationMode 197 Mode tcp 198 Target-name Name of the iSCSI target Name iSCSIName target-name No name target-name Target named eftcompany.com 200 Subscriber media Next-hopReverse Next-hop or next-hop reverse 202 Name name OwnerId id 203 Parse length number no parse length Parse length204 Parse protocol 205 CSG2 content configuration mode Configures content for CSG2 services, and enters206 Passthrough Configured, but none are activeEach time the service runs low on quota Passthrough quota-grantno passthrough Pending Pending timeout no pendingDefault pending connection timeout is 30 seconds Displays information about the CSG2 This policy, do not configure the accounting command Policy CSG2 contentPolicy-name Name of a configured CSG2 billing policy 209 Priority Services, and enters CSG2 policy configuration mode210 Policy Country priority Port port-number no port port-number No default behavior or valuesPort iSCSI 211 212 Reauthorization threshold 213 Ip csg service A1 Reauthorization threshold 214 Default maximum reauthorization timeout is 60 seconds Reauthorization timeoutDefault initial reauthorization timeout is 4 seconds 215 Maximum reauthorization timeout of 20 seconds 216 Default value is 0 no records delay Records delayRecords delay seconds no records delay Transaction closes, but before the connection closes Bytes bytes ServiceRecords granularity Seconds seconds 219 Seconds seconds Records intermediateBytes bytes 220 221 Policy-name Name of the refund policy RefundRefund policy-name No refund policy-name Refund If you do not specify a delay, there is no delay Replicate delay seconds no replicate delayConnection redundancy is not enabled Replicate Ip csg replicate Enables state replication between redundant CSG2 systems224 Rc-end RetcodeRc-start 225 Masks and values for CSG2 Prepaid Error Reimbursement 226 Sami rate bits-per-second all Default rate is 1.9 GbpsSami rate all No sami rate bits-per-secondall Service-name Name of a configured CSG2 billing service ServiceService service-name No service service-name None CSG2 billing configuration Show ip csg 229 Show ipc sctp UserIp-address ip-mask Id user-name Show ip csg accounting Command Default Command Modes Command HistoryShow module csg content Show module csg stats Detail Following example shows how to display the CSG2 statistics232 Router# show ip csg stats 233 234 Datagram packets = Datagram frags = 235 236 237 IPC 238 CSG Other Stats Total sessions = 40344, alloc fail = 239 Router# show ip csg quota-server 240Router# show ip csg sessions State Description 241 242 Show ip iscsi Command Default Command Modes Command History Examples243 Router# show ip iscsi stats iSCSI Stats 244Router# show ip iscsi stats detail iSCSI Stats 245 Target name= iqn.2002-10.edu.unh.iol.iscsi.draft20-target1 Router# show record-storage-module stats Show record-storage-module246 Router# show record-storage-module target-info all detail 247 State Snmp-server enable traps csgRecords 248 CSG2 records, and enters CSG2 Snmp timer configuration mode Following example enables CSG2 trapsIp csg snmp timer Snmp-server enable traps csg Http-header x-forwarded-for Subscriber-ip http-header forwarded-forObscure 250 251 Verify confirm token No verify confirm token Verify confirm252 253 No verify enable Verify enableVerify enable 254 No vlan Vlan CSG2 contentVlan vlan-number Vlan-number Dot1q encapsulation Vlan number Vrf Vrf-name VRF within which the content should match packetsVrf Contentvrf No vrf