Chapter 4, CANC Commands

Table Of Contents

CANC Commands and Messages

4.1  CANC

4.2  CANC-USER

4.3  CANC-USER-SECU

CANC Commands and Messages

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

4.1  CANC

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Cancel (CANC) message reports the occurrence of a session timeout event.

Usage Guidelines

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 Software 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] 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

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

<UID>

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

4.2  CANC-USER

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Cancel User (CANC-USER) command logs a user out of an active session with the NE.

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

Usage Guidelines

For the CANC-USER command:

CANC-USER:[TID]:[STRING]:CTAG

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

Category

Security

Security

Retrieve

Input Format

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

Input Example

CANC-USER:PETALUMA:TERRI:101;

Input Parameters

<USERID>

Identifies the user to the system. user ID can be up to 10 alphanumeric characters. It is a string.

4.3  CANC-USER-SECU

(Cisco ONS 15454, ONS 15327, ONS 15310-CL, ONS 15310-MA, ONS 15600) The Cancel User Security (CANC-USER-SECU) command forces a user off of the NE.

Usage Guidelines

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

Note This command will log out ALL sessions on the NE (TL1 and Cisco Transport Controller [CTC]) of a user whose user ID matches the UID specified in the command.

Category

Security

Security

Superuser

Input Format

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

Input Example

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

Input Parameters

<UID>

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