[Contents]
[Prev]
[Next]
[Index]
[Report an Error]
Using the CLI to Manage Subscriber Service Sessions
The CLI-based Service Manager creates static subscriber
sessions and service sessions. You can also use CLI commands to immediately
deactivate subscriber service sessions. The CLI-based support is particularly
useful for:
- Testing your service definitions—for example, you
might use the CLI commands to verify that a newly created service
definition is correct. When you are satisfied with the service definition,
you can then use RADIUS to activate the service for your subscribers.
- Preprovisioning Service Manager services—preprovisioning
improves performance and efficiency by freeing Service Manager from
having to repeatedly create and remove a service that you activate
and deactivate for multiple subscribers. See Preprovisioning Services for more
information about service preprovisioning.
Using the CLI to Activate Subscriber Service Sessions
A subscriber session represents a specific subscriber—the
session consists of the subscriber’s name, the interface used
for the session, and any active services for the subscriber. A subscriber
can have one subscriber session active at any given time.
You create a subscriber’s service session
when you assign a service definition to a subscriber session. Like
an AAA-created service, a single subscriber session can have multiple
simultaneous service sessions. You can use one method to create the
subscriber session, and then a different method to activate the subscriber’s
service session. For example, you might use RADIUS to create the AAA
subscriber session, then use the CLI to activate the service session
for the subscriber, You can optionally specify a service session profile
that you want to attach to the service session.
You can use the CLI to activate a service session
based on subscriber information or owner information:
- Subscriber name and interface method—Activates the
service session based on the subscriber name and the interface that
the subscriber is using for this subscriber session.
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“ tiered(1280000, 5120000)”
- Owner name and ID method—Activates the service session
based on the owner that created the subscriber session and the ID
that was generated by the owner. For example, if RADIUS is used to
create the subscriber session, the owner name is AAA and the owner
ID is the Acct-Session-ID that was generated by RADIUS during subscriber
creation.
- host1(config)#service-management owner-session
AAA 537446 service-session “ tiered(1280000,
5120000)”
 |
Note:
You must specify the parameter values in the order in
which the parameters appear in the template name of the service definition
file. Enclose the service definition name in double quotation marks,
with the service’s parameter values in parentheses. For example,
for the tiered service that is defined in Figure 27, the template name is:
- <# tiered(inputBW, outputBW) #>
Use the following format with the service-session keyword:
- “ tiered(1280000, 5120000)”
|
service-management owner-session
- Use to activate a service for an existing subscriber by
identifying the owner used to create the subscriber session and specifying
the service session to use.
- The subscriber session must exist before you use this
command.
- Use this command in Privileged Exec mode to create a dynamic
subscriber session—dynamic sessions are deleted after a router
reboot.
- Use this command in Global Configuration mode to create
persistent subscriber sessions that are retained across reboots.
- Specify the name of the owner (the method originally used
to create the subscriber session), and the ID generated by the of
the owner. For example, if RADIUS was used to create the subscriber
session, the owner name is AAA and the owner ID is the Acct-Session-ID
generated by RADIUS when the subscriber session was created.
- Include the optional service-session-profile keyword to assign a profile to the service session. The service
session profile includes additional attributes, such as the type of
statistics to be captured for the service session.
- You can activate one subscriber session for a subscriber—and
multiple service sessions for a particular subscriber session. If
you create a second subscriber session for the same subscriber, only
the newest subscriber session, with its services, is used.
- Example 1—Activate a service session for an existing
subscriber
- host1(config)#service-management owner-session
aaa 573498 service-session “video(4500000,
192.168.10.3)”
- Example 2—Activate multiple service sessions for
an existing subscriber
- host1(config)#service-management owner-session
aaa 573498 service-session “video(4500000,
192.168.10.3)”
- host1(config)#service-management owner-session
aaa 573498 service-session “tiered(1000000,
2000000)”
- host1(config)#service-management owner-session
aaa 573498 service-session “voice(1000000,
10.10.10.1)”
- Example 3—Include a service session profile when
you activate a subscriber’s service session
- host1(config)#service-management owner-session
aaa 426777 service-session “video(4500000,
192.168.10.3)” service-session-profile vodISP1
- Use the no version to deactivate
service sessions based on owner information. See Using the CLI to Deactivate Subscriber Service Sessions for more
information about deactivating subscriber service sessions.
- See service-management owner-session
service-management subscriber-session service-session
- Use to activate a service for a subscriber by creating
a subscriber session and a service session.
|
Note:
Always activate at least one service session for a subscriber
session. The ability to create a subscriber session without a service
session (by omitting the service-session keyword) is not currently supported.
|
- Use this command in Privileged Exec mode to create a dynamic
subscriber session—dynamic sessions are deleted after a router
reboot.
- Use this command in Global Configuration mode to create
persistent subscriber sessions that are retained across reboots.
- Include the optional service-session-profile keyword to assign a profile to the service session. The service
session profile includes additional attributes, such as the type of
statistics to be captured for the service session.
- You can create one subscriber session for a subscriber—and
multiple service sessions for a particular subscriber session. If
you create a second subscriber session for the same subscriber, only
the newest subscriber session, with its services, is used.
- Example 1—Activate a subscriber session with a single
service session
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“video(4500000, 192.168.10.3)”
- Example 2—Activate a single subscriber session with
multiple service sessions
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“video(4500000, 192.168.10.3)”
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“tiered(1000000, 2000000)”
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“voice(1000000, 10.10.10.1)”
- Example 3—Include a service session profile when
you activate a subscriber’s service session
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“video(4500000, 192.168.10.3)” service-session-profile vodISP1
- Use
the no version to deactivate service sessions.
See Using the CLI to Deactivate Subscriber Service Sessions
for more information about deactivating subscriber service sessions.
- See service-management subscriber-session service-session
Preprovisioning Services
Preprovisioning service sessions is a technique
you can use to improve Service Manager’s performance. Typically,
when you use a service definition to activate a subscriber’s
service session, Service Manager uses resources to build that service.
However, if you later use the same service definition to activate
a service session for a second subscriber, Service Manager does not
have to rebuild the service—it bases the new service on the
service that it built for the first service session. After you deactivate
the first session, Service Manager must build a new service for any
subsequent subscribers.
Preprovisioning entails activating a service for
a dummy user on the null interface. You can then use the preprovisioned
service session to activate service sessions for actual subscribers.
This technique improves performance because you only require Service
Manager to build the service one time, then reuse the original service
when you activate future subscriber service sessions.
To preprovision a service you use a command similar
to the following example:
- host1(config)#service-management subscriber-session
dummy interface null service-session “tiered(1000000,
2000000)”
Using Service Session Profiles
Service session profiles provide additional flexibility
to the Service Manager application by enabling you to assign one or
more supported attributes to a particular activation of a service.
For example, you might assign the same video service
to two subscribers, but use different service session profiles to
set different time limits for each subscriber’s service. One
subscriber uses the video service for 5 hours (18000 seconds) while
the other subscriber’s video service is for 10 hours (36000
seconds). Or, you might enable statistics on a subscriber’s
voice service and disable statistics on the same subscriber’s
video service.
You can create multiple service session profiles
independent of the service activation process. Then, when you activate
a service session, you specify the profile that you want to use with
that particular service session—you can apply one profile to
a service session.
You can configure the following attributes in service
session profiles:
-
statistics—Enables statistics
and specifies the type of statistics you want to capture for the service.
See Configuring Service Manager Statistics
for additional information about capturing Service Manager statistics.
You can specify the following types of statistics:
-
time—The service’s
duration
-
volume-time—The service’s
duration and traffic volume
-
volume—Specifies that
the service is automatically deactivated when the indicated traffic
volume is exceeded.
-
time—Specifies that
the service is automatically deactivated when the indicated time period
is exceeded.
|
Note:
The volume and time attributes use values captured by the Service Manager statistics
feature to determine when the threshold is exceeded. Service Manager
collects time statistics by default—you must configure and enable
volume statistics collection. See Configuring Service Manager Statistics .
|
To create or modify a service session profile:
- Specify the name of the service session profile; doing
this enters Service Session Profile Configuration mode.
- host1(config)#service-management service-session-profile
vodISP1
- host1(config-service-session-profile)#
- Specify the attributes you want to include in the profile.
- host1(config-service-session-profile)#statistics
volume-time
- host1(config-service-session-profile)#time
6000
- (Optional) To modify an existing profile, you can add
new attributes or use the no version of
a command to remove an attribute.
- host1(config-service-session-profile)#no time
service-management service-session-profile
- Use to create a new service session profile or to specify
the name of an existing profile you want to modify, and to enter Service
Session Profile Configuration mode.
- In Service Session Profile Configuration mode, you specify
the attributes used in the service session profile, such as the maximum
volume limit for the session and the maximum time the session can
be used. You can also specify that Service Manager collect statistics
for time, or volume, or both.
- Example
- host1(config)#service-management service-session-profile
vodISP1
- host1(config-service-session-profile)#
- Use the no version to delete
the service session profile.
- See service-management service-session-profile
statistics
- Use to enable statistics collection and to specify the
type of statistics to collect.
- Use the time keyword to collect
statistics about the duration of the service session.
- Use the volume-time keyword
to collect statistics about both the volume of traffic and the duration
of the service session.
- Example
- host1(config)#service-management service-session-profile
vodISP1
- host1(config-service-session-profile)#statistics
volume-time
- Use the no version to disable
statistics collection.
|
Note:
Service Manager statistics collection is a two-part procedure.
You must configure statistics information in the service definition
macro file and also enable statistics collection. See Configuring Service Manager Statistics .
|
- See statistics
time
- Use to specify the maximum amount of time that the service
session can be active for the subscriber.
- The router immediately terminates the subscriber’s
service session when the specified time is exceeded.
- The range is 0–16777251 seconds.
- Example
- host1(config)#service-management service-session-profile
vodISP1
- host1(config-service-session-profile)#time
6000
- Use the no version to delete
the time attribute from the service session profile.
- See time
volume
- Use to specify the maximum amount of bandwidth that can
use the service.
- The router immediately terminates the subscriber’s
service session when the specified traffic volume is exceeded.
|
Note:
The volume attribute uses values
captured by the Service Manager statistics feature to determine when
the threshold is exceeded. Therefore, you must configure and enable
statistics collection to use this attribute. See Configuring Service Manager Statistics .
|
- The range is 0–16777251MB.
- Example
- host1(config)#service-management service-session-profile
vodISP1
- host1(config-service-session-profile)#volume
1000000
- Use the no version to delete
the volume attribute from the service session profile.
- See volume
Using the CLI to Deactivate Subscriber Service Sessions
The CLI supports several methods that enable you
to manually deactivate service sessions. You can:
- Gracefully terminate all services or a specific service
for a particular subscriber
- Gracefully terminate all service or a specific service
associated with a particular owner
- Force the immediate termination of all of a subscriber’s
sessions
- Use service session profiles to create time or volume
thresholds for the service and deactivate the service when the threshold
is reached. See Using Service Session Profiles.
|
Note:
You can use the CLI commands described in this section to delete
subscriber and service sessions that are created by either RADIUS
or the CLI.
|
The Service Manager CLI commands enable you to
use variations of the no service-management subscriber-session command to terminate
service sessions.
Gracefully Deactivating Subscriber
Service Sessions
Use the following commands to gracefully deactivate
subscriber’s services—you can deactivate a specific service
for a subscriber, or you can delete a subscriber session, which deactivates
all of the subscriber’s service sessions. We recommend you use
this command to deactivate subscriber service sessions.
no service-management owner-session
- Use to gracefully deactivate service sessions for a subscriber
based on owner information.
- Specify the owner name and owner ID of the service session
you want to deactivate.
- Use the no version with the service-session keyword to deactivate the specified
service session.
- Use the no version without the service-session keyword to delete the subscriber’s session and deactivate
all of the subscriber’s service sessions.
- Example
- host1(config)#no service-management owner-session
aaa 426777 service-session “video(4500000,
192.168.10.3)”
- This is the no version of the service-management owner-session command.
- See service-management owner-session
no service-management subscriber-session service-session
- Use to gracefully deactivate service sessions for a subscriber.
- Use the subscriber’s username and interface, not
the subscriber session ID, for graceful deactivation.
- Use the no version without
the service-session keyword to delete the
subscriber’s session and deactivate all of the subscriber’s
service sessions.
- Use the no version with the service-session keyword to deactivate the specified
service session.
- Example
- host1(config)#no service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“tiered(1000000, 2000000)”
- This is the no version of the service-management subscriber-session command.
- See service-management subscriber-session service-session
Forcing
Immediate Deactivation of Subscriber Service Sessions
Use the following command to force the immediate
deactivation of the specified subscriber session—doing this
deletes all active service sessions for the subscriber. We recommend
this method if you encounter difficulty when you used the graceful
deactivation method. Always use the graceful method first.
no service-management subscriber-session force
- Use to force the immediate termination of a subscriber
session and to deactivate all services for the specified subscriber
session.
- You must specify the subscriber session ID to use the force keyword to terminate the subscriber session.
|
Note:
To
determine the subscriber session ID of a session you want to deactivate,
use the show service-management subscriber-session brief command. The display lists the IDs of all active subscriber sessions
and the owner that created the session, such as AAA (RADIUS) or CLI.
|
- Example
- host1(config)#no service-management subscriber-session 8 force
- There is no affirmative version of this command; there
is only a no version.
- See no service-management subscriber-session force
Using
Service Session Profiles to Deactivate Service Sessions
To terminate a subscriber service session when
a threshold is reached, you create a service session profile that
includes a time threshold, or a volume threshold, or both. Then, you
attach the service session profile when you activate the service session.
When the specified threshold is reached, the service session is terminated.
|
Note:
This feature is not supported by the service-management
owner-session command. The service-management
owner-session command only supports service session
profiles when activating service sessions.
|
The following example shows the commands you might
use to create a time threshold for deactivating a service session.
See Using Service Session Profiles
for information about using the time and volume keywords in service session profiles.
To create or modify a service session profile:
- Specify the name of the service session profile and configure
the threshold:
- host1(config)#service-management service-session-profile
vodISP1
- host1(config-service-session-profile)#time
6000
- host1(config-service-session-profile)#exit
- Include the service session profile when you activate
the subscriber service session:
- host1(config)#service-management subscriber-session
client1@isp1.com interface atm 4/0.1 service-session
“video(4500000, 192.168.10.3)” service-session-profile vodISP1
[Contents]
[Prev]
[Next]
[Index]
[Report an Error]
