6. Accessing devices through the client

This chapter, explains how to connect to device tools and run tasks on a device, covering:

6.1. Device states

Within the client window, you will see a list of device access (tools) and/or tasks. The devices are polled to check if the device is accessible and a status indicator given:

Icon Description
Red device icon The PxM Platform cannot connect to the device.
Orange device icon Some tasks run on the device are show errors.
Green device icon PxM Platform can successfully access the device.

6.2. Connecting to devices

To connect to a device session or run a task you need to double-click on either a device tool or device task. Depending on how the device access has been configured within the Web Management Interface by your SuperAdmin the following may also apply:

  • Session recording red box.
  • Access time windows.
  • Change ticket management tool.

6.2.1. Session recording overlay

When a device has been set for session recording a red banner will appear around the device connection. This indicates that your session will be recorded by PxM and available for SuperAdmin to playback and view.

Session Recording window

6.2.2. Access time windows

Access time window restrictions can be placed on connections through PxM. Restricted entries will show a countdown in brackets.

The following screenshot shows the tool greyed out and the time left until it is available.

Client Tool time to unlock

The following screenshot shows the tool is currently available and the time left until it becomes unavailable.

Client Tool time to lock

Once the access time has lapsed, any existing connection to the device will be terminated immediately.

6.2.3. Change ticket management tool

The Change ticket management tool appears under the PxM Virtual Appliance device. When connecting to a device which requires you to enter an approved change ticket number, then the Change ticket management tool will open.

This Change ticket management tool allows changes to be tracked and audited against your internal change request approval systems

Once the tool has been opened, it will always be seen in the forefront of all the screens you may have open. When a tool/task is opened that requires a change ticket, the focus will be automatically shifted to the change ticket management tool.

Having the Change ticket management tool window open whilst logged onto the client, allows you to quickly move between change tickets.

When you stop working within a change ticket, any existing connections to a device tool will be terminated.

Client Change Management tool

Using the Change ticket management tool:

  1. From within the client window, use the search to find the device you want to run the tool/task for.

  2. Double-click on the tool/task.

  3. Within the Change Ticket Required window, click Yes.

    Client Change Ticket Required window

  4. The Start change ticket window opens. Within the Ticket field, type in your change ticket reference and click Start. This will update with all the comments that have previously been made on this ticket.

    Client Start Change Ticket window

    Note

    If ServiceNow ticketing is being used, then the ticket entered will be validated against the servicenow host. If the ticket is not valid then you will see the following error:

    Change ticket validation error

  5. This will open the Ticket window, showing a history of all the comments that have been made on the ticket and the date they were made.

    Client Ticket comment history

  6. Click New comment, to add a new comment to the change ticket.

    Client Change Ticket New Comment

  7. Once you have entered you comment, click Save. The comment is added to the top of the comments list.

  8. To make comments to another change ticket, click Stop. This will take you back to the Start change ticket window, were you can type in the reference of another change ticket.

6.3. Running device tasks

Tasks that can be run on a device are configured within a device template. Once a device is provisioned in PxM, access to the available device tasks will be granted to you through profiles.

When you logon to the client, the list of devices and device tasks you have been granted privilges to access will be listed.

There are a number of types of tasks that you may encounter:
  • One click tasks that require no input.
  • Data collection task, will read something from a device and present the information.
  • Free input field task which will require you to enter some data before the task can be executed.
  • Dropdown list box task which requires to make a selection from the available list before the task is executed.

6.3.1. Running tasks

Execute a task on a single device

  1. From within the client window, use the search to find the device you want to run the task on.

  2. Double-click on the device task.

  3. Within the Execute Task window, click Execute to run the task on the listed device.

    WebUI Device Details Tasks Tab Execute

    Note

    If you are executing a task which requires a task input, you will be asked to select the input first.

    WebUI Device Detail Tasks Tab input parameters

  4. Within the Question window, click Yes.

    Dialog window

Execute a task on multiple devices

  1. From within the client window, use the search to find the device you want to run the task on.

  2. Double-click on the device task to be run.

  3. Within the Execute Task window, click Choose devices.

    Note

    If you are executing a task which requires a Task input, you will be asked to select the input first.

    WebUI Device Detail Tasks Tab input parameters

  4. Within the Select Devices section, check the unchecked box icon next to all devices in the list that you want to run the selected task against.

  5. Once you have selected all the devices, click Confirm.

  6. You are returned to the Execute on Devices window, click Execute to run the task on the selected devices.

  7. Within the Question window, click Yes.

    Dialog window

  8. The Action queue window opens, showing progress of the task executed. Click Continue in background or Done once the tasks have completed.

    WebUI Device Detail Tasks Tab Execute Action Queue