|
|
CSRC provides commands that you can use to de-activate and re-activate a subscriber, and reset a subscriber's modem.
These tools are:
If your company maintains complex relationships between your network service systems (such as DNS, DHCP, Provisioning) and your business systems (such as Customer Care and Billing), there may be times that you need to deny a customer Internet access.
The reasons for denying service can include:
CSRC does not implement the level of policy management needed to automatically disable service based on policy violations. Instead CSRC provides a tool that you can use to suspend access to the Internet and deny access to the User Registrar. The csrc_deactivate command is a command-line executable that de-activates an account, and then prevents that account from being used.
The csrc_deactivate command has the following syntax:
csrc_deactivate
{-account account_id | -userid user_id}
-cmsvc cm_service_name
-csrcadm csrc_adm_name
-csrcadmpw csrc_adm_pw
-reason reason_string
Table 9-1 displays the csrc_deactivate command arguments.
| Argument | Description |
|---|---|
-account account_id | Specifies the account identifier of the subscriber to de-activate. This is the account number that identifies the customer in the site's billing system and is a key into the CSRC LDAP data store. You must use this argument if you do not specify the -userid argument. |
-userid user_id | Specifies the user identifier of the subscriber to de-activate. This is the user identifier used to identify a customer to CSRC and a key into the CSRC LDAP data store. You must use this argument if you did not specify the -account argument. CSRC displays an error if you do not specify either the -account or the -userid argument. |
-cmsvc cm_service_name | Specifies the name of the service to use to de-activate this subscriber. You must specify this argument. |
-csrcadm csrc_adm_name | Specifies the administrator name to validate CSRC access. The csrc_adm_name must be a valid CSRC administrator. If you do not specify this argument CSRC reads it from stdin. |
Specifies the password for the administrator to validate CSRC access. The csrc_adm_pw must be the valid password for the administrator listed in the csrcadm argument. If you do not specify this argument CSRC reads it from stdin. | |
-reason reason_string | Specifies the string CSRC displays when the subscriber has been de-activated. This is an optional argument. |
The csrc_deactivate command denies Internet access for a subscriber by modifying data maintained in the CSRC datastore. The command authenticates against a directory server using a server domain name, and an administrator's name and password. You may specify account information by using the account identifier defined by your company's billing system.
The csrc_deactivate command de-activates a subscriber, and in order to resubscribe, the subscriber must be requalified. The csrc_deactivate command works in the following manner:
1. CSRC validates the CSRC administrator's name and password (from the command line or stdin) against the admin database. If an administrator with that name does not exist, or the password does not match, the csrc_deactivate command displays an error message and exits. (This step uses the -csrcadm and -csrcadmpw command-line arguments.)
2. CSRC reads a Subscriber object using the account ID or user name that you entered from the command line (using the -csrcadm or -csrcadmpw command-line arguments). CSRC reads a Modem object using the account ID or user name. CSRC reads Computer objects on the modem. CSRC reads a Service object based on the command-line argument -cmsvc.
3. If the subscriber is already disabled, the csrc_deactivate command returns and does not reset the cable modem. If CSRC cannot find the Service object or Modem object, the csrc_deactivate command displays an error.
4. CSRC updates the Modem object so that Modem.ServiceList is appended to Modem.PrevServiceList and Service is appended to Modem.ServiceList, as specified by the command-line argument -cmsvc. Also, Modem.ClientClass is set to the value of Service.CMClientClass.
5. CSRC updates each computer object behind a modem so that Computer[I].ClientClass is set to the value of Service.CompClientClass.
6. CSRC updates the Subscriber object so that Subscriber.IsDisabled equals TRUE and Subscriber.DisabledReason is set to the contents of the command-line argument -reason.
7. CSRC resets the cable modem.
To use the Internet again, the subscriber must contact the Customer Care Center representative who will use User Registrar to re-activate the subscriber.
To de-activate the subscriber with the user id jdoe, type.
csrc_deactivate -userid jdoe -csrcadm mwithers -csrcadmpw `123' -reason `Your access to the internet has been suspended for nonpayment. Please call 978.555.1212 to correct this situation' -cmsvc `Unprovisioned Service Class'
CSRC validates the de-activate session against the CRSC administrator mwithers, with password 123. CSRC displays the reason to the user. The CM and computer deactivation use the service listed on the command line to derive the appropriate client classes for the modem and the computers behind the modem.
The csrc_deactivate command returns 0 to indicate success and positive values to indicate errors. Table 9-2 shows the return codes and messages displayed on stdout.
| Error Code | Error String | Error Description |
|---|---|---|
0 | <none> | Success. |
101 | <Parameter Error Detail> | An argument error occurred (either missing or conflicting arguments). |
104 | "LDAP Server Bind Failure" | CSRC cannot bind the subscriber to the running LDAP server, probably due to an incorrectly configured LDAP authentication. |
105 | "Administrator not found" | The combination of administrator name and password is not valid. |
106 | "Unknown service class" | CSRC does not recognize the service class. |
107 | "No such user with given Userid/Account" | Incorrect user ID or account. |
108 | "Unable to initialize CSRC object layer" | Cannot start the CSRC object layer due to directory or file access problem, LDAP not running, or an incorrect configuration file. |
109 | "Modem deactivation failed" | The modem does not have the correct write community string, CSRC cannot find the correct lease, or the cable modem reset received an error. |
The csrc_reactivate command has the following syntax:
csrc_reactivate
{-account account_id | -userid user_id}
-cmsvc cm_service_name
-csrcadm csrc_adm_name
-csrcadmpw csrc_adm_pw
| Argument | Description |
|---|---|
-account account_id | Specifies the account identifier of the subscriber to re-activate. This is the account number that identifies the customer in the site's billing system and is a key into the CSRC LDAP data store. You must use this argument if you do not specify the -userid argument. |
-userid user_id | Specifies the user identifier of the subscriber to re-activate. This is the user identifier used to identify a customer to CSRC and a key into the CSRC LDAP data store. You must use this argument if you did not specify the -account argument. CSRC displays an error if you do not specify either the -account or the -userid argument. |
-cmsvc cm_service_name | Specifies the name of the service to use to re-activate this subscriber. You must specify this argument. |
-csrcadm csrc_adm_name | Specifies the administrator name to validate CSRC access. The csrc_adm_name must be a valid CSRC administrator. If you do not specify this argument CSRC reads it from stdin. |
Specifies the password for the administrator to validate CSRC access. The csrc_adm_pw must be the valid password for the administrator listed in the csrcadm argument. If you do not specify this argument CSRC reads it from stdin. |
The csrc_reactivate command reinstates Internet access for the subscriber by modifying the data maintained in the CSRC datastore. The command authenticates against a directory server using a server domain name, and an administrator's name and password. You may specify account information by using the account identifier defined by your company's billing system.
The csrc_reactivate command works in the following manner:
1. CSRC validates the CSRC administrator's name and password (from the command line or stdin) against the admin database. If an administrator with that name does not exist, or the password does not match, the csrc_reactivate command displays an error message and exits. (This step uses the -csrcadm and -csrcadmpw command-line arguments.)
2. CSRC reads a Subscriber object using the account ID or user name that you entered from the command line (using the -csrcadm or -csrcadmpw command-line arguments). CSRC reads a Modem object using the account ID or user name. CSRC reads Computer objects on the modem. CSRC reads a Service object based on the command-line argument -cmsvc.
3. If the subscriber is already disabled, the csrc_reactivate command returns and does not reset the cable modem. If CSRC cannot find the Service object or Modem object, the csrc_reactivate command displays an error.
4. CSRC updates the Modem object so that Modem.ServiceList is appended to Modem.PrevServiceList and Service is appended to Modem.ServiceList, as specified by the command-line argument -cmsvc. Also, Modem.ClientClass is set to the value of Service.CMClientClass.
5. CSRC updates each computer object behind a modem so that Computer[I].ClientClass is set to the value of Service.CompClientClass.
6. CSRC updates the Subscriber object so that Subscriber.IsDisabled equals FALSE.
7. CSRC resets the cable modem.
To re-activate the subscriber with the account 1001, validate the CSRC administrator admin with the password admin and the service default, type:
csrc_reactivate -account 1001 -csrcadm admin -csrcadmpw password -cmsvc default
The csrc_reactivate command re-activates the account to the service that the subscriber was using before the account was de-activated.
The csrc_reactivate command returns 0 to indicate success and positive values to indicate errors. Table 9-4 shows the return codes and messages displayed on stdout.
| Error Code | Error String | Error Description |
|---|---|---|
0 | <none> | Success. |
101 | <Parameter Error Detail> | An argument error occurred (either missing or conflicting arguments). |
104 | "LDAP Server Bind Failure" | CSRC cannot bind the subscriber to the running LDAP server, probably due to an incorrectly configured LDAP authentication. |
105 | "Administrator not found" | The combination of administrator name and password is not valid. |
106 | "Unknown service class" | CSRC does not recognize the service class. |
107 | "No such user with given Userid/Account" | Incorrect user ID or account. |
108 | "Unable to initialize CSRC object layer" | Cannot start the CSRC object layer due to directory or file access problem, LDAP not running, or an incorrect configuration file. |
109 | "Modem deactivation failed" | The modem does not have the correct write community string, CSRC cannot find the correct lease, or the cable modem reset received an error. |
When you activate or change a subscriber's service package, you must reboot the subscriber's cable modem to ensure that the subscriber receives the correct service. CSRC provides the csrc_resetcm command that you can use to reset a subscriber's cable modem.
The csrc_resetcm command has the following syntax:
csrc_resetcm
{-account account_id | -userid user_id}
{-ipaddress ip_address| -macaddress mac_address}
-csrcadm csrc_adm_name
-csrcadmpw csrc_adm_pw
| Argument | Description |
|---|---|
Specifies the account identifier of the subscriber's cable modem to reset. This is the account number that identifies a customer to your company's billing system and is a key into the CSRC LDAP data store. You must use this argument if you do not specify the -userid argument. | |
-userid user_id | Specifies the user identifier of the subscriber's cable modem to reset. This is the user identifier that identifies a customer to CSRC and is a key into the CSRC LDAP data store. You must use this argument if you do not specify -account. CSRC displays an error you do not specify the -account or the -userid argument. |
Specifies the IP address of a subscriber's cable modem to reset. If you want to reset all the IP addresses associated with a specific subscriber, use the value all. CSRC checks that the IP address belongs to the subscriber before resetting the modem. | |
Specifies the MAC address of a specific cable modem. If you want to reset all the IP addresses associated with a specific subscriber, use the value all. CSRC checks that the MAC address belongs to the subscriber before resetting the modem. | |
Specifies the administrator's name to validate CSRC access. The csrc_adm_name must be a valid CSRC administrator. If you do not specify this argument, CSRC reads it from stdin. | |
Specifies the administrator's password to validate CSRC access. The csrc_adm_pw must be the valid password for the administrator. If you do not specify this argument, CSRC reads it from stdin. |
The csrc_resetcm command reboots all modems or a single cable modem associated with a specific subscriber.
The csrc_resetcm command works in the following manner:
1. CSRC validates the CSRC administrator's name and password (from the command line or stdin) against the admin database. If an administrator with that name does not exist, or the password does not match, the csrc_resetcm command displays an error message and exits. (This step uses the -csrcadm and -csrcadmpw command-line arguments.)
2. CSRC reads a Subscriber object using the account ID or user name that you entered from the command line (using the -csrcadm or -csrcadmpw command-line arguments). CSRC reads a Modem object using the account ID or user name. CSRC reads Lease objects based on Modem objects. CSRC validates the MAC address or IP address against the Modem objects or Lease objects. If the cable modem's MAC address or IP address does not belong the subscriber, the csrc_resetcm command returns an error and does not reset the cable modem.
3. CSRC requires the write community string to reset the modem. It can get the write community string from the Modem object. If it is not there, it searches the default Config Object. If CSRC cannot find the write community string, it returns an error, and aborts the reset command.
4. CSRC resets the cable modem.
The following examples show different ways that you can use the csrc_resetcm command:
csrc_resetcm -account 102345
csrc_resetcm -userid jdoe -macaddress 1,6,00:00:03 -csrcadm mwithers -csrcadmpw `123'
csrc_resetcm -userid jdoe -macaddress all -csrcadm mwithers -csrcadmpw `123'
The csrc_resetcm command returns 0 to indicate success and positive values to indicate errors. Table 9-6 displays the error return codes and messages that are delivered to stdout.
| Error Code | Error String | Error Description |
|---|---|---|
0 | <none> | Success. |
101 | <Argument Error Detail> | An argument error occurred (either missing or conflicting arguments). |
104 | "LDAP Server Bind Failure" | CSRC cannot bind the subscriber to the running LDAP server, probably due to an incorrectly configured LDAP authentication. |
105 | "Administrator not found" | The combination of CSRC administrator name and password is not valid. |
106 | "Cable Modem not found" | The cable modem with specific MAC address or IP address does not belong to the specified subscriber. |
107 | "No such user with given Userid/Account" | There is no subscriber with that Userid or Account. |
108 | "Unable to initialize the CSRC object layer" | The CSRC object layer cannot start due to a directory or file access problem, LDAP is not running, or there is an incorrect configuration file. |
109 | "Modem reset failed" | The modem does not have the correct write community string, cannot find the correct lease, or the cable modem reset received a error. |
![]()
![]()
![]()
![]()
![]()
![]()
![]()
Posted: Fri Oct 22 07:44:50 PDT 1999
Copyright 1989-1999©Cisco Systems Inc.