Space banner This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

Opening a Telnet or SSH session

This topic provides instructions on opening a Telnet or SSH session from the TrueSight Network Automation user interface.

Opening a Telnet or SSH session

On the Network > Actions > Telnet/SSH Session page, do the following:

  1. Enter information in the fields as follows:

    • Change ID: (Optional) Track this span action to an external Change ID (for example, internal RFC process or Remedy). To assist with change documentation, the Job Summary report summarizes the Job Details for each span action referencing the same Change ID.
       If Continuous Compliance for Network Automation is enabled in the system parameters, what you enter in the Change ID field is masked according to the mask specified in the global.properties file. You can use this feature to enter only the unique low-order characters of the Change ID.

      Note

      The default mask is CRQ000000000000. If you enter 12345, then the Change ID is masked to CRQ000000012345.

      If what you enter does not fit the mask pattern (for example, too many digits or non-numeric characters), an error message appears.
       These validations are performed when Telnet/SSH is used through a proxy command prompt. For more information, see Validation of Change ID and Task ID.

    • Task ID: (Optional) Track this span action to an external Task ID. To assist with change documentation, the Job Summary report summarizes the Job Details for each span action referencing the same Task ID.
       In a manner similar to Change ID, what you enter in the Task ID field is masked according to the mask specified in the global.properties file. The default task mask is TAS000000000000. See Default-global-properties-file. For more information about the validation of the Task ID, see Validation of Change ID and Task ID .
    • Under Network Span, enter the following information: 
      • Ensure that Device is selected as the Span Type. 
      • Select the required realm.
      • Select the required device.
    • Annotation: (Optional) Specify a description for the session. This description is added to the Telnet/SSH Session Job Details.
    • Options: Select the Use Auxiliary Interface option to use the auxiliary interface for connecting to the device. When this option is not selected, or when the span is not a device, the primary interface is used.

  2. Login Username and Login Password: Enter the user name and password for the selected device.

    These fields are only displayed when the selected device has an access mode of SSH or Auto. These types of device connection require that the user name and password be provided before the session starts, unlike devices that have a Telnet access mode.

    Note

    The user can also login to the selected device using credentials from the Device Security Profile. To do this, you must do the following:

    • Source of Device Login Username/Password for Jobs system parameter is set to Device Security Profile. See Managing-system-parameters.
    • Your user roles need the appropriate network rights to use Device Security Profile as Source of Login for Telnet/SSH Session within the selected device's realm, which is a sub-right of their network realm's Action right, Run Associated Telnet/SSH Session Action. See Securing-access-through-user-roles.

      If your user roles have the Login to Privileged Mode sub-right within the Run Associated Telnet/SSH Session Action right, the system logs you into the device's privileged mode when the Terminal is launched.
  3. Click Submit to start the Telnet or SSH session.

Validation of Change ID and Task ID

The following validations can be performed in a Telnet/SSH job during the opening of the session:

  • The Change ID, if specified, must be valid in BMC Remedy Change Management.
  • The Task ID, if specified, must be valid in BMC Remedy Change Management.
  • The task that matches the specified Change ID and Task ID must be in the Assigned state.
  • The job must be scheduled to run within the Scheduled Start and Stop Dates of the task that matches the specified Change ID and Task ID.
  • The specified device must be a CI in BMC Remedy that is related to the task that matches the specified Change ID and Task ID.

Two global properties are available to indicate whether and what validation checks should be enforced, as listed in the following table:

Property

Description

aoEnforceTerminalJobsValidation

Determines whether or not enhanced validation checks should be made for the Change ID and Task ID fields when creating the Terminal Job. The default value is false.

aoTerminalJobValidation

Specifies the validation checks that are performed for the Change ID and Task ID when creating the Terminal Job.

These checks are performed only when the aoEnforceTerminalJobsValidation global property is true.

To specify which checks should be made, list one or more of the following keywords. Use a comma (,) to separate consecutive keywords:

validateChangeTaskExist

Validates that the Change ID and Task ID exist in BMC Remedy IT Service Management

validateTaskStatusAssigned

Validates that the change is scheduled and the task is assigned

validateTaskUser

Validates that the user who originates the job is the user that is assigned to the task

Note: The full names of the user in Network Automation and BMC Remedy must match exactly.

validateTaskDate

Validates that the job run time falls between the task's Scheduled Start and Stop dates

validateTaskCI

Validates that the device in the job is the device specified in the task

The default is all options selected: aoTerminalJobValidation= validateChangeTaskExist,validateTaskStatusAssigned, validateTaskUser,validateTaskDate,validateTaskCI

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*