Skip to content

Accessing devices and running tasks

Here we look at the different devices states, look at how to single sign-on to a devices tool and execute tasks on device(s).

This section covers:

Device states

The list of devices presented in the PxM Client interface are polled to check if the device is accessible by the PxM Platform and given an appropriate status indicator based on what is received back.

The meaning of the device status indicators are as follows:

Indicator Description
Green The PxM Platform can successfully access the device.
Orange Some tasks running on the device are showing errors.
Red The PxM Platform is unable to connect to the device.

Single signing onto device tools

Device tools listed under individual devices in the PxM Client interface can be opened by double-clicking on the tool. The PxM Virtual Appliance manages the authentication and sign-on process so you won't be prompted to enter any credentials and simply signed onto the device.

The credentials used to sign-on to the device will have a predefined access level. The access level can be seen next to the tool on the PxM Client interface. This access level will determine the level of permission and privilege granted for the device session and is set by the PxM superadmin.

Additional features

When accessing device tools there maybe additional requirements implemented which you may need to be aware of. These may include:

Session recording

Some device connections maybe recorded for audit and tracking purposes. When you open a device tool that has been marked for session recording, a red banner will appear around the device tool connection window. This indicates that any actions performed within the window will be recorded. Recorded sessions are stored and can be viewed by a PxM superadmin.

SR red box

Change management

Device sessions opened through the PxM Platform can be subject to change management control to minimise impact on services. When implemented you will be prompted to enter a change ticket identifier with the PxM Platform Change Management Tool before being single signed on to the selected device tool.

Changes carried out under a change ticket are tracked and can be audited against your internal change request approval systems.

Once the change ticket management tool has been opened, it will always be seen in the forefront of all the screens you may have open. When a tool 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 PxM 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.

Change management tool

The following explains how to use the Change ticket management tool when prompted:

  1. From within the PxM Client interface window, use the search to find the device tool you want to open.

  2. Double-click on the device tool to open.

  3. If you are prompted with the Change Ticket Required window, click Yes to continue.

    Clicking No will close the window and you won't be single signed onto the device.

    Change ticket required window

  4. The Change Ticket Required window is closed and the the Start change ticket window opens.

    Start change ticket

  5. Within the Start change ticket field, type in your change ticket identifier.

    Change ticket ID entered

    Note

    If your organisation uses the ServiceNow Incident Management system, then the ticket entered will be validated against the ServiceNow host. If the ticket is invalid you will be prompted with the following error:

    ServiceNow validation error

  6. Click Start. The window will be updated, showing a history of all the comments that have been made on the ticket and the date they were made.

    Change ticket ID comments list

  7. Click New comment. Within the Ticket: [ticket_id] window add a comment for the work you are about to carry out under this change ticket.

    PxM-Components

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

    PxM-Components

  9. To stop making changes under the change ticket opened or to open and start a different change ticket, click Stop. This will take you back to the Start change ticket window, where you can type in the reference of another change ticket.

Executing device tasks

The execution of tasks refers to commands that can be run on a device to perform a set action. The PxM Client lists the tasks you have been granted access to and have permission to execute on the device. You do not need to know the command when executing the task as the command is provided by the PxM Platform during runtime.

A task can also be executed on multiple devices of the same type which saves time and the effort of logging onto each device and running the task multiple times.

Tasks available can be executed in a variety of forms, these include:

  • One click: No input required.
  • Data collection: A value is read from the device and the output presented within a window.
  • Free input field: Requires a value to be entered before the task can be executed.
  • Dropdown list box: Requires a selection to be made from a predefined list.

To execute a task:

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

  2. Double-click on the device task you want to execute. The Execute task [task_name] window opens.

    Execute task devices

  3. If the task requires an Input you will be presented with the Input tab. If the task does not require an input then skip to step 4.

    Example of a task that requires input: Execute tasks with inputs

  4. To execute the task on just the device listed, select the device listed and then skip to step 7. To select multiple devices go to skip to step 5

  5. To select multiple devices click Choose devices next to Execute on devices. The window will update and list all the devices that the task can be executed on.

  6. Select the device(s) you want to execute the task on and then click Confirm.

    Select device(s)

  7. Now click Execute to run the task on the device(s) selected.

    Selected devices

  8. If the task requires a change ticket you will be presented with the following. Otherwise skip to step 9.

    Task change ticket question

    • Click Yes with the Question window

    • The Change Ticket Required window is closed and the the Start change ticket window opens.

      Start change ticket

    • Within the Start change ticket field, type in your change ticket identifier. Change ticket ID entered

      Note

      If your organisation uses the ServiceNow Incident Management system, then the ticket entered will be validated against the ServiceNow host. If the ticket is invalid you will be prompted with the following error:

      ServiceNow validation error

    • Click Start. The window will be updated, showing a history of all the comments that have been made on the ticket and the date they were made.

      Change ticket ID comments list

    • Click New comment. Within the Ticket: [ticket_id] window add a comment for the work you are about to carry out under this change ticket. PxM-Components

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

      PxM-Components

    • To stop making changes under the change ticket opened or to open a start a different 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.

  9. Within the Question window, click Yes.

    Task question

  10. Wait while the task is executed. Once completed click Done in the Action queue window.

    Task action queue

  11. If you have a change ticket open, click Stop within the Ticket window.

Downloading task files

Files generated through the execution of a task from the PxM Client can be downloaded from the Web Management Interface.

To download a file:

  1. From within the PxM Client interface window, double-click the Browser (HTTP) - Role: User tool.

    Browser role user

  2. The Web Management Interface will open in a browser window.

    User Web UI

  3. Within the Web Management Interface click My files in the left-hand menu.

  4. The My files window will open listing all the files created through execution of tasks by you.

    My files

  5. To download a file click on the Save icon at the end of the row in the table. The file will be downloaded.