ONS SONET TL1 Command Guide R8.5.1 -- CANC Commands and Messages

From DocWiki

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

Contents 1 CANC 1.1 Usage Guidelines 1.2 Category 1.3 Security 1.4 Output Format 1.5 Output Example 1.6 Output Parameters 2 CANC-USER 2.1 Usage Guidelines 2.2 Category 2.3 Security 2.4 Input Format 2.5 Input Example 2.6 Input Parameters 3 CANC-USER-SECU 3.1 Usage Guidelines 3.2 Category 3.3 Security 3.4 Input Format 3.5 Input Example 3.6 Input Parameters

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.

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.

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.