Chapter 4, CANC Commands

Table Of Contents

CANC Commands

4.1  CANC

4.2  CANC-USER

4.3  CANC-USER-SECU

CANC Commands

This chapter provides CANC (cancel) commands for the Cisco ONS 15454, ONS 15327, ONS 15600 and ONS 15310-CL.

4.1  CANC

Cancel

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

Reports the occurrence of a session timeout event.

CANC is an autonomous message transmitted by the NE to a user when a session established by that user is terminated because no messages were exchanged for a long period of time (a timeout). There is a default timeout period based on the user's privilege/security level. Starting with Release 4.0, timeouts can be provisioned through CTC. Starting with Release 4.6, timeouts can be provisioned through TL1 with the SET-ATTR-SECUDFLT command. The default timeouts based on privilege/security level are:

•A Superuser [SUPER] has a timeout period of 15 minutes.

•A Provisioning [PROV] user has a timeout period of 30 minutes.

•A Maintenance [MAINT] level user has a timeout period of 60 minutes.

•A Retrieve [RTRV] user has no timeout period.

When a timeout occurs, the corresponding port drops the session and the next session initiation at that port requires the regular login procedure.

The CANC message is only used to indicate that a session has been terminated because of a timeout. If a session is terminated for a different reason (for example, forced logout, loss of communication), the REPT EVT SESSION message is used.

Category

Security

Security

Retrieve

Related Commands

ACT-USER

ALW-MSG-SECU

ALW-USER-SECU

CANC-USER

CANC-USER-SECU

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

INH-USER-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-CMD-SECU

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT

Output Format

SID DATE TIME
A ATAG CANC
"<UID>"
;

Output Example

TID-000 1998-06-20 14:30:00
A 100.100 CANC
"CISCO15"
;

Output Parameters

Table 4-1 CANC Output Parameters

Parameter and Values

Description

UID

The user identifier (userid) of the person logged in. Refers to the userid of a user whose session is terminated due to timeout. String

4.2  CANC-USER

Cancel User

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command logs a user out of an active session with the NE.

Note The USERID field of this command is a mandatory field.

For the CANC-USER command: CANC-USER:[TID]:[STRING]:CTAG

the syntax of the userid (first [STRING]) is not checked. Invalid syntax for the userid is permitted and the userid must not exceed 10 characters.

Category

Security

Security

Retrieve

Related Commands

ACT-USER

ALW-MSG-SECU

ALW-USER-SECU

CANC

CANC-USER-SECU

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

INH-USER-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-CMD-SECU

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT

Input Format

CANC-USER:[<TID>]:<USERID>:<CTAG>;

Input Example

CANC-USER:PETALUMA:TERRI:101;

Input Parameters

Table 4-2 CANC-USER Input Parameters

Parameter and Values

Description

USERID

Identifies the user to the system. USERID can be up to 10 alphanumeric characters. String

4.3  CANC-USER-SECU

Cancel User Security

Usage Guidelines

Cisco ONS 15454, ONS 15327, ONS 15600, ONS 15310-CL

This command forces a user off of the NE.

The UID specified can be a single userid or a list of userids separated by "&". The keyword ALL is not permitted. The UID specified cannot be the userid of the administrator issuing the command.

Note This command will log out ALL sessions on the NE (TL1 and CTC) of a user whose userid matches the UID specified in the command.

Category

Security

Security

Superuser

Related Commands

ACT-USER

ALW-MSG-SECU

ALW-USER-SECU

CANC

CANC-USER

CLR-COND-SECU

DLT-USER-SECU

ED-CMD-SECU

ED-PID

ED-USER-SECU

ENT-USER-SECU

INH-MSG-SECU

INH-USER-SECU

REPT ALM SECU

REPT EVT SECU

REPT EVT SESSION

RTRV-CMD-SECU

RTRV-DFLT-SECU

RTRV-USER-SECU

SET-ATTR-SECUDFLT

Input Format

CANC-USER-SECU:[<TID>]:<UID>:<CTAG>;

Input Example

CANC-USER-SECU:PETALUMA:CISCO10:100;

Input Parameters

Table 4-3 CANC-USER-SECU Input Parameters

Parameter and Values

Description

UID

The user identifier (userid) of the person logged in. UID can be a list of userids separated by "&". The keyword ALL may not be used to specify all users on an NE. String