Disconnects
subscribers based on specified criteria.
Privilege
Security
Administrator, Administrator, Operator
Mode
Exec
The following prompt
is displayed in the Exec mode:
[local]host_name#
Syntax
clear subscribers [ keywords ] [ verbose ] [ -noconfirm ]
The keywords are
filters that modify or filter the criteria for deciding which subscriber
sessions to clear and are described below. Multiple keywords can be entered on
a command line.
When multiple
keywords are specified, the subscriber sessions deleted must meet the
specifications of all of the keywords.
For example; if you
enter the following command:
clear subscribers ip-pool pool1 card-num 1
Only subscriber
sessions that were assigned an IP address from the IP pool named
pool1 and are
also being processed by the processing card in slot
1 are cleared.
All other subscriber sessions that do not meet these criteria remain and are
not cleared.
Important
|
Calls already
marked as disconnecting will not be designated for clearing. For example, if
100 calls are temporarily in the disconnecting state, the
show
subscribers all command output displays all 100 calls. However, the
clear
subscribers all command output will indicate that there are no calls
available for clearing, since they are already in the disconnecting state.
When clearing the subscribers while the service is in an ACTIVE state, the subscribers get reattached anytime.
|
Note
|
In the CUPS environment, you must execute this command on control plane (CP) and not on user plane (UP).
|
-noconfirm
Executes the command
without any additional prompt and confirmation from the user.
Important
|
The Operator
privilege does not have access to this keyword.
|
active
Only disconnects
subscribers who currently have active sessions.
active-charging-service
ecs_service_name
Clears information
for subscribers using the Active charging Service.
ecs_service_name must be the name of the Active
Charging Service, expressed as an alphanumeric string of 1 through 15
characters.
all
Disconnects all
subscribers.
Important
|
The Operator
privilege does not have access to this keyword.
|
apn
apn_name [ rulename rule_name | without-dynamic-rule | without-override-control ]
Clears all PDP contexts accessing a specific access point name (APN).
apn_name is the name of the APN expressed as an alphanumeric string of 1 through 63 characters that is case sensitive.
Note
|
If there is an apn ,ebi or ipAddr value for a single PDN during multiPDN S+P call scenarios, all the subscribers having the same callid get cleared at the S-GW.
|
[ rulename rule_name | without-dynamic-rule | without-override-control ]
rulename rule_name is the charging rule name.
without-dynamic-rule refers to subscribers without any dynamic rule associated with them.
without-override-control refers to subscribers without any override control rule associated with them.
asn-peer-address
ip_address
Clears information
for subscribers on an ASN-GW trusted peer.
ip_address is the address of the ASN-GW peer
server entered using IPv4 dotted-decimal notation.
asngw-service
service_name
Clears counters for
subscribers accessing the ASN-GW service.
service_name must be an existing service expressed
as an alphanumeric string of 1 through 63 characters.
asnpc-service
service_name
Clears counters for
subscribers accessing the ASN PC service.
service_name must be an existing service expressed
as an alphanumeric string of 1 through 63 characters.
bandwidth-policy
bandwidth_policy_name
Clears information
for subscribers using the specified bandwidth policy.
bandwidth_policy_name must be the name for an
existing bandwidth policy, expressed as an alphanumeric string of 1 through 63
characters.
bearer-establishment { direct-tunnel | normal | pending
}
Clears all
subscribers from the specified bearer establishment type.
direct-tunnel : Select subscribers having direct
tunnel establshed with the RNC.
normal : Select subscribers having bearer
established with SGSN.
pending : Select subscribers for whom bearer is not
fully established.
bng-only
Clears information
related to BNG calls only.
bng-service
service_name
Clears all
subscribers from the specified BNG service.
service_name must be an existing service expressed
as an alphanumeric string of 1 through 63 characters.
callid
id
Clears the call
specified by
call_id . The
call ID must be specified as a 4-byte hexadecimal number.
card-num
card_num
The slot number of
the processing card by which the subscriber session is processed.
card_num is a
slot number from 1 through 7 or 10 through 16 (for the ASR 5000) or from 1
through 4 or 7 through 10 (for the ASR 5500).
cbb-policy
cbb_policy_name
Clears information
for subscribers using the specified CBB policy.
cbb_policy_name must be the name for an existing
CBB policy expressed as an alphanumeric string of 1 through 63 characters.
ccoa-only
This option clears
the subscribers that registered a MIP co-located COA directly with the HA.
This option is
only valid when MIPHA session license is enabled.
cgw-only
Clears information
related to CGW calls only.
configured-idle-timeout [ < | > | greater-than | less-than
]
value
Disconnects
subscribers whose idle timeout matches the specified criteria. A value of 0
(zero) indicates that the subscribers idle timeout is disabled.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared.
value must be
an integer from 0 through 4294967295.
connected-time [ < | > | greater-than | less-than ]
value
Disconnects
subscribers who have been connected for the specified length of time.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared.
value must be
an integer from 0 through 4294967295.
css-delivery-sequence
name
Important
|
This is a
restricted keyword. In
StarOS 9.0 and later, this keyword is obsoleted.
|
css-service
name
Important
|
This is a
restricted keyword. In
StarOS 9.0 and later, this keyword is obsoleted.
|
del-cause { none | reactiv-req }
When subscribers
are deleted, the GGSN/P-GW/SAEGW may include "Cause-IE" in the resulting Delete
Bearer/Delete PDP Context Requests generated for default bearer.
none : Omit GTP "Cause-IE" in DBR/DPC generated for
default bearer.
reactiv-req : The DBR/DPC will include "Cause-IE"
with GTP cause code "Reactivation Requested".
The behavior for
"Cause-IE" will be effective only if the
clear
subscribers command results in the sending of a Delete Bearer
Request for default bearer, or Delete PDP Context is sent to delete the PDN
connection or its last PDP context.
The behavior for
"Cause-IE" specified in this CLI shall override the cause-code set by existing
features.
Important
|
This option is
only valid when Cause IE Enhancement for Delete Bearer Request license is
enabled. Contact your Cisco account representative for more information.
|
dhcp-server
address
Clears all PDP
contexts that currently possess an IP address assigned from a specific DHCP
server.
dhcp_address
is the IP address of the DHCP server expressed in IPv4 dotted-decimal notation.
dormant
Only disconnects
subscriber sessions that are dormant (not transmitting or receiving data).
ebi number
Clears subscribers
based on an EPS bearer identity (EBI).
number must
be a valid EBI and an integer value from 5 to 15.
Note
|
Deprecated for mme-service.
|
enodeb-address ip_address
Clears subscribers
based on the eNodeB to which they are attached.
ip_address
must be a valid IP address of an existing eNodeB entered using IPv4
dotted-decimal or IPv6 colon-separated-hexadecimal notation.
epdg-address ip_address
Clears subscribers
based on the ePDG to which they are attached.
ip_address
must be a valid IP address of an existing ePDG entered using IPv4
dotted-decimal or IPv6 colon-separated-hexadecimal notation.
The following
filter keywords are valid with this command:
epdg-address, epdg-service,
epdg-service service_name
Clears subscribers
of a configured ePDG service.
service_name
must be a valid string of size 1 to 63.
The following
filter keywords are valid with this command:
epdg-address, epdg-service
fa
ip_address
Disconnects all
subscribers connected to the foreign agent specified by the IP address in IPv4
dotted-decimal notation.
fa-service
fa_name
Disconnects all
subscribers connected to an existing foreign agent name.
firewall { not-required | required }
Clears all
subscriber information for the specified subscribers:
not-required : Subscribers for whom firewall
processing is not-required.
required : Subscribers for whom firewall processing
is required.
firewall-policy
fw_policy_name
This keyword is
obsolete.
fw-and-nat policy
fwnat__policy_name
Clears information
for subscribers using the specified Firewall-and-NAT policy.
fwnat_policy_name must be the name of an existing
Firewall-and-NAT policy expressed as an alphanumeric string of 1 through 63
characters.
fng-service
service_name
Clears subscriber
sessions connected to the FNG service.
service_name
must be an existing service expressed as an alphanumeric string of 1 through 63
characters.
ggsn-service
name
Clears all PDP
contexts accessing an existing GGSN service specified as an alphanumeric string
of 1 through 63 characters that is case sensitive.
gprs-only
lai mcc mobile_country_code mnc mobile_network_code lac location_area_code
Notes:
-
gprs-only : Specifies the clearing of SGSN 2G subscribers only.
-
lai : Specifies location area identity.
-
mcc
mobile_country_code : Specifies mobile country code. mobile_country_code must be a string of size 3 to 3 ranging from 100 through 999.
-
mnc
mobile_network_code : Specifies mobile network code.mobile_network_code must be a string of size 2 to 3 ranging from 00 through 999.
-
lac
location_area_code : Specifies location area code. location_area_code must be an integer from 1 to 65535.
gprs-service
name
Clears all PDP
contexts associated with the 2G SGSN. This keyword can be used with filtering
keywords that are part of the
clear
subscriber command set.
Using this keyword
can trigger a network-initiated service request (paging) procedure.
name identifies a specific GPRS service
configuration expressed as an alphanumeric string of 1 through 63 characters.
gsm-traffic-class { background | conversational | interactive { priority } | streaming }
Subscribers whose traffic matches the specified 3GPP traffic class.
-
background : 3GPP QoS background class.
-
conversational : 3GPP QoS conversational class.
-
interactive : 3GPP QoS interactive class. Must be followed by a traffic priority. priority can be configured to any integer value from
1 to 3.
-
streaming : 3GPP QoS streaming class.
gtpu-bind-address
ip_address
Disconnects all
subscribers connected to the GTP-U service bind address.
ip_address must be specified in IPv4
dotted-decimal or IPv6 colon-separated-hexadecimal notation.
gtpu-service
service_name
Disconnects all
subscribers and erase subscriber information based on the GTP-U service name.
service_name
must be an existing GTP-U service expressed as an alphanumeric string of 1
through 63 characters.
gtp-version
Displays the
specific GTP version number. Must be followed by one of the supported GTP
versions (0 or 1).
The following
filter keywords are valid with this command:
active-charging-service,
apn, asngw-service,
asnpc-service, asn-peer-address, bearer-establishment, callid, card-num,
coaa-only, configured-idle-timeout, connected-time, dhcp-server, fa,
fa-service,
firewall,
ggsn-service,
gprs-service, gsm-traffic-class, gtp-version, ha, ha-ipsec-service, ha-service,
idle-time, ims-auth-service, imsi, ip-address, ip-alloc-method, ip-pool,
ipv6-address, ipv6-prefix, l3-tunnel-local-addr, lac, lac-service, lns,
lns-service, long-duration-time-left, mip-udp-tunnel-only, mipv6ha-service,
msid, msisdn, network-requested, network-type, pcf,
pdg-service,
pdif-service, pdsn-service,
pdsnclosedrp-service,
plmn-type, rulebase, rx-data, session-time-left, sgsn-address,
sgsn-service, tx-data, username, grep, more
ha
address
Disconnects all
subscribers connected to the home agent.
ha_address must be specified using IPv4
dotted-decimal notation.
ha-ipsec-only
Disconnects all
MIP HA sessions with IPSec tunnels.
ha-service
name
Disconnects all
subscribers connected to the home agent specified by
ha_name must
have been previously defined.
henbgw-access-service
svc_name
Important
|
In Release 20, 21.0 and 21.1, HeNBGW is not supported. This keyword must not be used for HeNBGW in these releases. For more
information, contact your Cisco account representative.
|
Disconnects all
subscribers and erase subscriber information based on the HeNB-GW access
service name.
henbgw-only
Important
|
In Release 20, 21.0 and 21.1, HeNBGW is not supported. This keyword must not be used for HeNBGW in these releases. For more
information, contact your Cisco account representative.
|
Disconnects
subscribers emerging from a HeNBGW service configured on this system.
hnbgw-service
svc_name
Important
|
In Release 20 and later, HNBGW is not supported. This keyword must not be used for HNBGW in Release 20 and later. For more
information, contact your Cisco account representative.
|
Disconnects all subscribers and erase subscriber information
based on the HNB-GW service name.
svc_name must
be an existing HNB-GW service expressed as an alphanumeric string of 1 through
63 characters.
hsgw-only
Disconnects
subscribers emerging from a HRPD Serving Gateway (HSGW) service configured on
this system.
hsgw-service
name
Disconnects
subscribers using this HRPD Serving Gateway (HSGW) service configured on this
system.
name must be
an existing HSGW service expressed as an alphanumeric string of 1 through 63
characters.
idle-time [ < | > | greater-than | less-than ]
value
Disconnects
subscribers whose idle time matches the specified length of time.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared.
value must be
an integer from 0 through 4294967295.
imei
imei
SGSN only.
Disconnects one or
more subscribers based on the international mobile equipment identity (IMEI or
IMEI-SV) of the subscriber's mobile equipment.
imei - enter 14 to 16 digits to match the first 14
digits of a retrieved IMEI/IMEISV for a single subscriber. to match a range of
subscribers, the string may be shorter and include '$' as a wildcard for a
single digit or '*' as a wildcard for multiple digits.
ims-auth-service
imsa_service_name
Disconnects
subscribers using this IMS Authorization Service configured on this system.
imsa_service_name must be an existing IMS
Authorization Service expressed as an alphanumeric string of 1 through 63
characters.
imsi
id
Disconnects the
subscriber with the specified id. The IMSI (International Mobile Subscriber
Identity) ID is a 50-bit field which identifies the subscriber's home country
and carrier. Wildcard characters $ and * are allowed. The * wildcard matches
multiple characters and the $ wildcard matches a single character. If you do
not want the wildcard characters interpreted as a wildcard enclose them in
single quotes ( ' ). For example; '$'.
interface-type { S2bGTP | S5S8GTP }
Disconnects
subscribers based on their interface type.
S2bGTP : Indicates that the GTP protocol is used on
the S2b interface for the subscribers being disconnected.
S5S8GTP : Indicates that the GTP protocol is used
on the S5/S8 interface for the subscribers being disconnected.
ip-address
ip_address
Disconnects all
subscribers connected to the specified
ip_address .
The address must be specified using IPv4 dotted-decimal notation.
Note:
This keyword is not supported for use with the MME or SGSN.
ip-alloc-method { aaa-assigned | dhcp [ relay-agent | proxy-client ] | dynamic-pool | l2tp-lns-assigned | mip-ha-assigned
| ms-provided-static | not-ms-provided-static | static pool }
Displays the specific IP Allocation Method. Must be followed by one of the IP Allocation Methods:
-
aaa-assigned : Selects subscribers whose IP Addresses were assigned by AAA.
-
dhcp : Selects subscribers whose IP Addresses were assigned by DHCP.
-
dynamic-pool : Selects subscribers whose IP Addresses were assigned from a dynamic IP address pool.
-
l2tp-lns-assigned : Selects subscribers whose IP Addresses were assigned by the Layer 2 Tunnelling Protocol Network Server.
-
mip-ha-assigned : Selects subscribers whose IP Addresses were assigned by the Mobile IP Home Agent.
-
ms-provided-static : Selects subscribers whose IP Addresses were provided by the Mobile Station.
-
not-ms-provided-static : Selects subscribers whose IP Addresses were not provided by the Mobile Station.
-
proxy-client : Selects subscribers whose IP Addresses were assigned by the DHCP Proxy Client
-
relay-agent : Selects subscribers whose IP Addresses were assigned by the DHCP Relay Agent
-
static-pool : Selects subscribers whose IP Addresses were assigned from a static IP address pool.
ip-pool
name
Disconnects all
subscribers assigned addresses from the IP address pool
pool_name .
pool_name
must be the name of an existing IP pool or IP pool group.
ipv4
Clears all
subscribers with IPv4 Firewall enabled/disabled.
ipv6
Clears all
subscribers with IPv6 Firewall enabled/disabled.
ipv6-address
ipv6_address
Clears all
subscribers connected to the specified IPv6
ipv6_address
must be specified in IPv6 colon-separated-hexadecimal notation.
Note:
This keyword is not supported for use with the MME or SGSN.
ipv6-prefix
prefix
Clears subscribers
from a specific IPv6 address prefix.
l3-tunnel-local-addr
ip_address
Disconnects all
calls for this Layer 3 tunneling interface.
ip_address must be specified in IPv4
dotted-decimal or IPv6 colon-separated-hexadecimal notation.
l3-tunnel-remote-addr
ip_address
Disconnects all
calls for this Layer 3 tunneling peer.
ip_address must be specified in IPv4
dotted-decimal or IPv6 colon-separated-hexadecimal notation.
lac
ip_address
Disconnects all
calls to the peer LAC (L2TP access concentrator).
ip_address must be specified using IPv4
dotted-decimal notation.
lac-service
service_name
Disconnects all
calls for this LAC service.
service_name is an alphanumeric string of 1
through 63 characters.
lma-service
lma_name
Disconnects
subscribers using this LMA service configured on this system.
lma_name must
be an existing LMA service expressed as an alphanumeric string of 1 through 63
characters.
lns
ip_address
Disconnects calls
to the peer LNS (L2TP network server) specified by
ip_address
must be specified using IPv4 dotted-decimal notation.
lns-service
name
Disconnects calls
associated with the LNS service named
name .
name is an
alphanumeric string of 1 through 63 characters.
long-duration-time-left [ < | > | greater-than | less-than
]
value
Disconnects
subscriber sessions whose time left for the maximum duration of their session
matches the length of time specified.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared.
value must be
an integer from 0 through 4294967295.
mag-service
name
Disconnects
subscribers using this Mobile Access Gateway (MAG) service configured on this
system.
name must be an existing MAG service and be from 1
to 63 alphanumeric characters.
max-subscribers
max_count [ uniform ]
The maximum number
of subscribers to be cleared.
max_count must be an integer from 0 through
20000000.
uniform : Subscribers will be cleared uniformly.
mip-udp-tunnel-only
This option clears
the subscribers that negotiated MIP-UDP tunneling with the HA.
This option is
only valid when MIP NAT Traversal license is enabled.
mipv6ha-service
service_name
Disconnects
subscribers using this MIPV6 Home Agent service configured on this system.
service_name must be an existing MIPV6 HA service
and be from 1 to 63 alphanumeric characters.
mme-address
ipv4_addr
Disconnects
subscribers using this peer Mobility Management Entity (MME).
ipv4_addr
must be an existing peer MME IP address entered using IPv4 dotted-decimal
notation.
mme-onlytai mcc
mobile_country_code mnc mobile_network_code tac tracking_area_code
Disconnects all
MME subscriber sessions on the system.
-
tai
: Specifies specific tai interface. Must be followed by mcc, mnc and tac.
-
mcc
mobile_country_code : Specifies mobile country code. mobile_country_code must be a string of size 3 to 3 ranging from 100 through 999.
-
mnc
mobile_network_code : Specifies mobile network code. mobile_network_code must be a string of size 2 to 3 ranging from 00 through 999.
-
tac
tracking_area_code : Specifies tracking area code. tracking_area_code must be an integer value between 1 and 65535.
mme-service
name
Disconnects
subscribers using this MME service configured on this system.
name must be
an existing MME service expressed as an alphanumeric string1 through 63
characters.
mseg-only
Important
|
This keyword is not supported in this release.
|
mseg-service
mseg_service_name
Important
|
This keyword is not supported in this release.
|
msid
id
Disconnects the
mobile user identified by
ms_id .
ms_id must be
from 7 to 16 digits specified as an IMSI, MIN, or RMI. Wildcard characters $
and * are allowed. The * wildcard matches multiple characters and the $
wildcard matches a single character. If you do not want the wildcard characters
interpreted as a wildcard enclose them in single quotes ( ' ). For example;
'$'.
In case of
enforce imsi-min
equivalence is enabled on the chassis and MIN or IMSI numbers
supplied, this filter will clear subscribers with a corresponding MSID (MIN or
IMSI) whose lower 10 digits matches to lower 10 digits of the supplied MSID.
clear subscribers msid
111110123456789 or
clear subscribers msid
0123456789
will clear any
subscriber with a MSID that match the lower 10 digits of MSID supplied, i.e.
0123456789.
msisdn
msisdn
Clears information
for the mobile user identified by Mobile Subscriber ISDN Number (MSISDN).
msisdn must
be from 7 to 16 digits specified as an IMSI, MIN, or RMI.
nat { not-required | required [ nat-ip
nat_ip_address
| nat-realm
nat_realm_name
] }
Clears all
subscriber information for the specified subscribers:
not-required : Subscribers for whom NAT processing
is not required.
required : Subscribers for whom NAT processing is
required.
Important
|
The
nat-ip
keyword is only available in StarOS 8.3 and later.
|
nat-ip
nat_ip_address : Subscribers for whom NAT
processing is enabled and are using the specified NAT IP address.
nat_ip_address specifies the NAT IP address using
IPv4 dotted-decimal notation.
nat-realm
nat_realm_name : Subscribers for whom NAT
processing is enabled and are using the specified NAT realm.
nat_realm_name specifies the NAT realm name
expressed as an alphanumeric string of 1 through 63 characters.
network-requested
Disconnect
subscriber sessions that were initiated by the GGSN network requested create
PDP context procedure.
network-type { gre | ipv4 | ipv6 | ipip | l2tp | mobile-ip | proxy-mobile-ip }
Disconnects subscriber sessions based on the network type. The following network types can be selected:
-
gre : Generic Routing Encapsulation (GRE) per RFC 2784
-
ipv4 : Internet Protocol version 4 (IPv4)
-
ipv6 : Internet Protocol version 6 (IPv6)
-
ipip : IP-in-IP encapsulation per RFC 2003
-
l2tp : Layer 2 Tunneling Protocol encryption per RFC 2661
-
mobile-ip : Mobile IP
-
proxy-mobile-ip : Proxy Mobile IP
non-volte-call [ auto-delete ] [ del-cause { none | reactiv-req } ]
[ max-subscribers
max_count [ uniform ] ]
[ pace-out-interval
interval_in_seconds ]
Disconnects PDN
connections that do not have an active voice call.
This keyword is
available for APN and chassis maintenance for P-GW, S-GW, SAEGW, GGSN, and
ePDG.
auto-delete : Clears the PDN/call when the last
VoLTE dedicated bearer goes down for P-GW, S-GW, SAEGW, GGSN, and ePDG.
Calls will not be
cleared when one of the calls in a multiple PDN scenario is a VoLTE PDN. When
the VoLTE PDN goes down, all of the other PDNs found for the same IMSI are
brought down, which will bring down the call automatically.
pace-out-interval
interval_in_seconds
The
clear subscribers non-VoLTE
auto-delete command was implemented in StarOS release 17.0. This
command can generate a burst of Delete Bearer Requests (DBR) and Delete Session
Requests (DSR) in customer setups. To prevent the flooding of peer nodes with
session removal control procedures, it is important to distribute these
messages in a periodic manner.
The
pace-out-interval keyword allows operators to
specify the time duration for removing the sessions so that control messages
sent across to peer nodes are evenly distributed.
Sessions that are
"paced-out" over a period of time move into a disconnecting state; however,
data and control path activity continue as usual until the system sends out
session deletion message(s). In the case of session recovery, "paced-out"
sessions are recovered in the connected state and the
clear
subscriber command must be initiated again to clear the recovered
sessions.
pace-out-interval is the time, in seconds, that
session deletion messages are distributed.
interval_in_seconds must be an integer from 0 to
86400.
pcf [ < | > | less-than | greater-than ] ipv4_address [ [ < | > | less-than | greater-than ] ipv4_address ]
Displays information for subscribers connected via the packet control function with a specific or range of IP address ipv4_ddress . The address must be specified using IPv4 dotted-decimal notation.
-
< : Filters output so that only information less than the specified IPv4 address value is displayed.
-
> : Filters output so that only information greater than the specified IPv4 address value is displayed.
-
less-than : Filters output so that only information less than the specified IPv4 address value is displayed.
-
greater-than :Filters output so that only information greater than the specified IPv4 address value is displayed.
Note: It is possible to define a limited range of IP addresses by using the less-than and greater-than options to define minimum
and maximum values.
pcp { not-required | required }
Clears all
subscriber information for the specified subscribers:
not-required : Subscribers for whom PCP processing
is not required.
required : Subscribers for whom PCP processing is
required.
pdsn-service
name
Disconnect all
subscribers connected to the packet data service
pdsn_name .
The packet data service must have been previously configured.
pdsnclosedrp-service
service_name
Disconnect all
subscribers connected to the Closed R-P service
service_name .
The Closed R-P service must have been previously configured.
pdg-service
service_name
Disconnects
subscriber sessions that are using the PDG service.
service_name must be an existing
service expressed as an alphanumeric string of 1 through 63 characters.
pdif-service
service_name
Clears counters
for subscribers accessing the Packet Data Interworking Function (PDIF) service.
service_name must be an existing service expressed
as an alphanumeric string of 1 through 63 characters.
pgw-address
ip_address
Clears specific
P-GW interface.
ip_address must be followed by IP address of
interface, using IPv4 dotted-decimal or IPv6 colon-separated-hexadecimal
notation.
The following
filter keywords are valid with this command:
epdg-address, epdg-service,
pgw-only { all
[ del-cause { none |
reactiv-req } ]
[ max-subscribers
max_count ]
[ pace-out-interval
interval_in_seconds ]
| imsi
id ebi
id | mag-address
ip_addr | pgw-service
name | sgw-address
ip_addr }
all : Disconnects all subscribers for all P-GW
services on this system.
imsi
id :
Disconnects subscribers based on their International Mobile Subscriber
Identification (IMSI).
id must be
the 3-digit MCC (Mobile Country Code), follow by the 2 or 3 digits of the MNC
(Mobile Network Code) and the MSIN (Mobile Subscriber Identification Number).
id should not exceed 15 digits.
Example:
123-45-678910234 must be entered as 12345678910234
ebi
id : The EBI
(EPS Bearer Identity)
id must be a valid EBI and be an integer value
from 5 to 15.
mag-service
ip_addr :
Disconnects all subscribers using this MAG address.
pgw-service
name :
Disconnects all subscribers using this P-GW service.
name must be an existing P-GW service expressed as
an alphanumeric string of 1 through 63 characters.
sgw-address
ip_addr :
Disconnects all subscribers using this S-GW IP address.
ip_addr must be an existing IP address entered
using IPv4 dotted-decimal notation or IPv6 colon-separated-hexadecimal
notation.
plmn-type { home | roaming | visiting }
For GGSN,
disconnects subscribers whose subscriber type matches the specified type.
profile-id
id
Clears information
for subscribers using thegranted profile-id for the flow.
id must be an integer from 0 to 4294967295.
profile-name
name
Clears information
for subscribers using the specified policy profile name.
name must be name of an existing profile expressed
as an alphanumeric string of 1 through 63 characters.
qci
number
Disconnects
subscribers based on their QCI identity.
number must be an integer from 0 to 9.
rulebase
rulebase_name
Clears information
for subscribers using the specified rulebase.
rulebase_name must be name of an existing rulebase
expressed as an alphanumeric string of 1 through 63 characters.
rulename rule_name
Displays subscribers associated with the specific rule name. The
rule_name options are: predefined, static, and dynamic rules..
rx-data [ < | > | greater-than | less-than ]
value
Disconnects
subscribers who have received the specified number of bytes of data.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared.
value must be
an integer from 0 through 18446744073709551615.
s1u-state { active | idle | idle-active }
Disconnects
subscribers based on their S1-User Plane Protocol State.
active : Selects subscribers having S1-U state set
to active.
idle : Selects subscribers having S1-U state set to
idle.
idle-active : Selects subscribers having S1-U state
set to idle-active.
s5-proto { gtp | pmip }
Disconnects
subscribers based on their S5 interface protocol type.
gtp : Indicates that the GTP protocol is used on
the S5 interface for the subscribers being disconnected.
pmip : Indicates that the PMIP protocol is used on
the S5 interface for the subscribers being disconnected.
saegw-only { all [ max-subscribers max_count ] [ pace-out-interval interval_in_seconds ] | co-located | imsi id ebi id | pgw-anchored | saegw-service name | sgw-address ip_addr | sgw-anchored | uplane-address up_ip_address | user-plane-group up_group_name }
all : Disconnects all subscribers for all SAEGW services on this system.
co-located : Disconnects only co-located subscribers which have both S-GW and P-GW functions.
imsi
id : Disconnects subscribers based on their International Mobile Subscriber Identification (IMSI). id must be the 3-digit MCC (Mobile Country Code), follow by the 2 or 3 digits of the MNC (Mobile Network Code) and the MSIN
(Mobile Subscriber Identification Number).
id should not exceed 15 digits.
Example: 123-45-678910234 must be entered as 12345678910234
ebi
id : The EBI (EPS Bearer Identity)
id must be a valid EBI and be an integer value from 5 to 15.
pgw-anchored : Disconnects only PGW-anchored subscribers.
saegw-service name : Disconnects all subscribers using this SAEGW service.
name must be an existing SAEGW service expressed as an alphanumeric string of 1 through 63 characters.
sgw-address ip_addr : Disconnects all subscribers using this S-GW IP address.
ip_addr must be an existing IP address entered using IPv4 dotted-decimal notation or IPv6 colon-separated-hexadecimal notation.
sgw-anchored : Disconnects only SGW-anchored subscribers.
uplane-address up_ip_address : Disconnects the specific user plane address. up_ip_address must be the user plane IP address in dotted decimal notation.
user-plane-group up_group_name : Disconnects the specific user plane group. up_group_name must be the name of the user plane group.
saegw-service name
Disconnects all
subscribers using this SAEGW service.
name must be
an existing SAEGW service expressed as an alphanumeric string of 1 through 63
characters.
session-time-left [ < | > | greater-than | less-than ] value
The amount of time
left for the subscriber session.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared.
value must be
an integer from 0 through 4294967295.
sgsn-address ip_address
Clears all PDP
contexts currently being facilitated by a specific SGSN.
ip_address is the IP address of the SGSN entered
using IPv4 dotted-decimal notation.
sgsn-only lai mcc mobile_country_code mnc mobile_network_code lac location_area_code
Notes:
-
sgsn-only : Specifies the clearing of SGSN 3G subscribers only.
-
lai : Specifies location area identity.
-
mcc mobile_country_code : Specifies mobile country code. mobile_country_code must be a string of size 3 to 3 ranging from 100 through 999.
-
mnc mobile_network_code : Specifies mobile network code. mobile_network_code must be a string of size 2 to 3 ranging from 00 through 999.
-
lac location_area_code : Specifies location area code. location_area_code must be an integer from 1 to 65535.
sgsn-service name
Clears all PDP
contexts associated with SGSN. This keyword can be used with filtering keywords
that are part of the
clear
subscriber command set.
Using this keyword
can trigger a network-initiated service request (paging) procedure.
name identifies a specific SGSN-service
configuration expressed as an alphanumeric string of 1 through 63 characters.
sgw-address ip_address
Disconnects
subscribers using the Serving Gateway (S-GW) IP address.
ip_address must be specified in IPv4
dotted-decimal or IPv6 colon-separated-hexadecimal notation.
sgw-only all [ max-subscribers
max_count [ uniform ] ]
[ pace-out-interval
interval_in_seconds ]
[ verbose ]
Disconnects all
S-GW subscriber sessions on the system.
sgw-service name
Disconnects
subscribers using this Serving Gateway (S-GW) service configured on this
system.
name must be
an existing S-GW service expressed as an alphanumeric string of 1 through 63
characters.
smgr-instance sessmgr_instance_number
Disconnects
subscribers on the specified sessmgr instance.
sessmgr_instance_number must be an integer from 1
to 4294967295.
tpo { not-required | required }
Important
|
The Traffic
Performance Optimization (TPO) in-line service is not supported in this
release.
|
tx-data [ < | > | greater-than | less-than ] value
Disconnects
subscribers who have transmitted the specified number of bytes of data.
< : Filters output so that only information less
than the specified value is cleared.
> : Filters output so that only information
greater than the specified value is cleared.
greater-than : Filters output so that only
information greater than the specified value is cleared.
less-than : Filters output so that only information
less than the specified value is cleared.
value : If no other filtering options are specified
only output matching
value is
cleared. If
value is not
specified all data is cleared. value must be an integer from 0 through
18446744073709551615.
username name
Disconnect the
subscriber with the specified username
name is the username of the subscriber to be
cleared.
name must be
a sequence of characters and/or wildcard characters ('$' and '*') from 1 to 127
characters. The * wildcard matches multiple characters and the $ wildcard
matches a single character. If you do not want the wildcard characters
interpreted as wildcard enclose them in single quotes ( '). For example; '$'.
verbose
Indicates the
output should provide as much information as possible. If this option is not
specified then the output is the standard level which is the concise mode.
without-dynamic-rule
Displays subscribers without any dynamic rule associated with them.
without-override-control
Displays subscribers without any override control rule associated with
them.
wsg-service name
Disconnects
subscribers using this WSG service configured on this ASR 9000 VSM.
name must be
an existing WSG (SecGW) service expressed as an alphanumeric string of 1
through 63 characters.
grep grep_options | more
Pipes (sends) the
output of this command to the specified command. You must specify a command to
which the output of this command will be sent.
For details on the
usage of
grep and
more , refer
to the
Regulating a
Command's Output section of the
Command Line
Interface Overview chapter.
Usage Guidelines
Clear subscribers sessions to aid in troubleshooting the system when no additional subscribers may connect or when a specific
service or remote address may be having connection problems. This command may also be used to clear connections when preparing
for maintenance activities.
Note
|
In the CUPS environment, you must execute this command on control plane (CP) and not on user plane (UP).
|
Related commands to clear subscription data - for SGSN use only
-
For a 2G SGSN, the admin-disconnect-behavior clear-subscription command in the GPRS Service Configuration mode enables the SGSN to clear subscription data after the administrative disconnect
- clear subscribers all has been issued.
-
For a 3G SGSN, the admin-disconnect-behavior clear-subscription command in the SGSN Service Configuration mode enables the SGSN to clear subscription data after the administrative disconnect
- clear subscribers all has been issued.
Example
The following
examples illustrate the basic command usage as well as the redirection of the
command output. Not all options are exemplified as all options follow the same
basic constructs.
The following are
basic subscriber clearing examples.
clear subscribers username ser1
clear subscribers ha sampleService
clear subscribers ip-pool pool2 verbose
The following command disconnects users connected to the foreign agent with IP address 209.165.200.229 . clear subscribers fa 209.165.200.229
Feedback