Command Engine

This feature allows users to execute cumulative or selective commands on target devices.

This will help with quick diagnostics scenarios wherein groups of commands specific to identifying the status on target devices could be retrieved and showcased on the console.

Command Master

This screen allows users to create commands that will be executed on target devices. On this screen, user with proper roles can approve and reject commands.

Create Command
  1. To create a command, click on icon.
    Figure 1. Create Command
  2. Provide the command name.
  3. Provide the Category for the command.
  4. Provide the Subcategory for the command.
  5. Provide the Device Type for the command.
  6. Provide the Model Id for the command.
  7. Provide the Manufacturer for the command.
  8. Provide the command.
    Figure 2. Create Command (Cont.)
  9. Click on save. Below alert appears:
    Figure 3. Create Command (Cont.)
  10. The added command appears in the grid:
    Figure 4. Create Command (Cont.)
  11. To view the command, click on icon and the command details appear in the read only mode.
    Figure 5. Create Command (Cont.)
  12. To edit any command, click on icon. The fields get prefilled with the existing data. Make the required changes and update it.
    Figure 6. Create Command (Cont.)
  13. To delete a command, click on icon. A confirmation box appears:
    Figure 7. Create Command (Cont.)
  14. Click on Yes. The below alert appears, and command gets deleted:
    Figure 8. Create Command (Cont.)
Approve Command
  1. To approve the command, user must have the role ‘Command Approver’. Login with such user, and on Command Master page, user can view all the commands in open state in Open State. All the approved commands can be viewed under Approved Tab and all rejected commands under Rejected Tab.
    Figure 9. Command Approver Login
  2. To approver a command in open tab, click on icon. The popup appears:
    Figure 10. Command Approver’ Login (Cont.)
  3. Provide a valid Change Request Number to be associated with the command to be approved and provide the approval remarks then click Approve.
    Note:
    The data source for Change Request is mandatory because based on its configuration, the existence of Change Request Number is checked.

    Disclaimer: In the product, we’re just validating the Change Request Number existence on ITSM tool. We’re not the owner of the change request and are responsible for any modifications and updates made on the ticket.

  4. Below alert appears:
    Figure 11. Command Approver’ Login (Cont.)
  5. The command then moves from Open tab to Approved Tab.
    Figure 12. Command Approver’ Login (Cont.)
Reject Command
  1. To approve the command, user must have the role ‘Command Approver’. Login with such user, and on Command Master page, user can view all the commands in open state in Open State.
  2. All the approved commands can be viewed under Approved Tab and all rejected commands under Rejected Tab.
    Figure 13. Reject Command
  3. To approver a command in open tab, click on icon. The popup appears:
    Figure 14. Reject Command (Cont.)
  4. Provide a valid Change Request Number to be associated with the command to be approved and provide the approval remarks then click Approve.
    Note:
    The data source for Change Request is mandatory because based on its configuration, the existence of Change Request Number is checked.

    Disclaimer: In the product, we’re just validating the Change Request Number existence on ITSM tool. We’re not the owner of the change request and are responsible for any modifications and updates made on the ticket.

  5. Below alert appears:
    Figure 15. Reject Command (Cont.)
  6. The command then moves from Open tab to Approved Tab.
    Figure 16. Reject Command (Cont.)
Reject Command

To reject the command, user must have the role ‘Command Approver’. Login with such user, and on Command Master page, user can view all the commands in open state in Open State.

All the approved commands can be viewed under Approved Tab and all rejected commands under Rejected Tab

  1. To reject a command in open tab, click on icon. The popup appears:
    Figure 17. Reject Command
  2. Provide valid remarks for rejection and click on Reject.
  3. Below alert appears:
    Figure 18. Reject Command (Cont.)
  4. The rejected command now appears in Rejected tab.
    Figure 19. Reject Command (Cont.)

Command Scheduler

This screen allows user to schedule the commands created earlier to be executed on a target device.

To schedule the command, go to Command Engine then Command scheduler page.

Note:

Disclaimer: We’re not responsible for any sort of validation on the commands being executed nor are we responsible for the execution on target device as Ansible is responsible for this.

  1. Click on icon, below slider opens:
    Figure 20. Command Scheduler
    Note:
    User can schedule only those commands that have been enabled for Command Engine Execution on Manage Runbooks page.
    Figure 21. Command Scheduler (Cont.)
  2. Select Runbook Tool, Runbook to be scheduled, and Filters for CI
    Figure 22. Command Scheduler (Cont.)
  3. Select applicable filters for the command. Only commands that are satisfied by these filters will be applicable for execution.
    Figure 23. Command Scheduler (Cont.)
  4. Select the appropriate type and field in runbook parameters.
    1. Text: User can provide the textual value for the parameter
    2. SecureText: User can provide the value from any vault
    3. Command: User can select the commands that have been created based on the filters selected for commands.
    4. CI: User can select the CIs based in the filters selected for CI.
      Figure 24. Runbook parameters
    5. Click on Schedule Now.
    6. A ticket has been created with prefix CMD that can be viewed on Tickets console. User can track its execution and status.