First steps
  • 8 minutes to read
  • Dark
    Light
  • PDF

First steps

  • Dark
    Light
  • PDF

Article Summary

This document provides a step-by-step guide on how to configure senhasegura’s Task Manager module.

Requirements

To use the Task Manager module, you’ll need:


Register an environment

Info

If you already have the desired environment registered in senhasegura, the configuration below is not necessary.

To register an environment in senhasegura, follow the steps below:

  1. On senhasegura, in the upper-left corner, click the Grid Menu, represented by the nine squares, and select SYSTEM > Settings.

  2. In the side menu, select System parameters > Segmentation > Environments.

  3. In the upper-right corner, click View actions, represented by the three vertical dots icon, and select New.

  4. On the New environment screen:

    1. Name*: enter a human-readable name for the environment registered.
    2. Enabled: check Yes or No to define whether the environment will be active or inactive.
    Info

    The items with an asterisk are mandatory.

  5. Click Save.

A pop-up window with the message “Success. Data saved successfully!” confirms the action.

Info

On the Environments screen, through the Action column, you can edit and disable a registered environment.

  • To edit, identify the desired environment in the list or use the filters to search for it, and in the Action column, click Edit, represented by the pencil and paper icon.
  • To disable the environment, in the Action column, click the three vertical dots icon and select Disable, represented by the trash can icon.

Register a system

Info

If you already have the desired system registered in senhasegura, the configuration below is not necessary.

To register a system in senhasegura, follow the steps below:

  1. On senhasegura, in the upper-left corner, click the Grid Menu, represented by the nine squares, and select SYSTEM > Settings.
  2. In the side menu, select System parameters > Segmentation > Systems.
  3. In the upper-right corner, click View actions, represented by the three vertical dots icon, and select New.
  4. On the New system screen:
    1. Name*: enter a human-readable name for the system registered.
    2. Enabled: check Yes or No to define whether the system will be active or inactive.
Info

The items with an asterisk are mandatory.

  1. Click Save.

A pop-up window with the message “Success. Data saved successfully!” confirms the action.

Info

On the Systems screen, through the Action column, you can edit and disable a registered system.

  • To edit, identify the desired system in the list or use the filters to search for it, and in the Action column, click Edit, represented by the pencil and paper icon.
  • To disable the system, in the Action column, click the three vertical dots icon and select Disable, represented by the trash can icon.

Register a reason to run a task

To register a reason that can be used when submitting a task execution request in Task Manager, follow the steps below.

Info

The requirement to provide a reason when requesting the execution of a task is defined during the creation of the access group in which the task is included. For more information, access the document on How to manage access groups.

  1. On senhasegura, in the upper-left corner, click the Grid Menu, represented by the nine squares, and select Task Manager.
  2. In the side menu, select Settings > Reasons.
  3. In the upper-right corner of the Reasons screen, click the View actions menu, represented by the three vertical dots icon, and select New.
  4. On the New task reason screen:
    1. Name*: enter a human-readable name for the reason registered.
    2. Type*: click the downward arrow to select one of the registered reason types.
    3. Enabled*: check Yes or No to define whether the reason will be active or inactive.
Info

The items with an asterisk are mandatory.

  1. Click Save.

A pop-up window with the message “Success. Data saved successfully!” confirms the action.

Register an execution template

To register an execution template that can be used when creating a task in Task Manager, follow the steps below:

  1. On senhasegura, in the upper-left corner, click the Grid Menu, represented by the nine squares, and select Task Manager.
  2. In the side menu, select Settings > Templates.
  3. In the upper-right corner of the Execution templates screen, click the View actions menu, represented by the three vertical dots icon, and select New.
  4. On the Execution template screen:
    1. Name*: enter a human-readable name for the template registered. Example: “Linux - Restart services”.
    2. Enabled*: check Yes or No to define whether the template will be active or inactive.
    3. Executor*: click the downward arrow to select one of the available plugins that the template will use.
    4. Execution type*: click the downward arrow and select Task Manager.
    5. Playbook: click the downward arrow to select an available playbook.
    6. Inventory: click the downward arrow to select an available inventory.
    7. Content: enter the commands that will be executed in the task.
    Info

    The items with an asterisk are mandatory.

    Info

    The View TAGs button displays a legend of the TAGs that can be used in the templates.

The following example shows how TAGs can be used in template creation:

#Check service status
        expect "*$"
        exec "service --status-all"

        #Root user access
        expect "*$"
        exec "sudo su"

        #Add root user password
        expect "*:"
        exec "[#AUTH_PASSWORD#]"

        #Stop service
        expect "*#"
        exec "service [#VARIABLE#] stop"

        #Service status
        expect "*#"
        exec "service [#VARIABLE#] status"

        #Restart service
        expect "*#"
        exec "service [#VARIABLE#] restart"

        #End execution task
        expect "*#"
        end
Info

At the top of the Execution template screen, click the external link icon, represented by an arrow coming out of a square, to be directed to GitHub, where you can view all templates from the Executions module.

  1. Click Save.

A pop-up window with the message “Success. Data saved successfully!” confirms the action.

Info

On the Execution templates screen, through the Action column, you can edit, clone, and view the change history of a template.

  • To edit, identify the desired execution template in the list or use the filters to search for it, and in the Action column, click Edit, represented by the pencil and paper icon.
  • To clone the execution template, in the Action column, click the three vertical dots icon and select Clone, represented by the two sheets of paper icon. During this process, you may change the name of the cloned template or keep the same name as the original template followed by the word (copy) and its identification code.
  • To view the change history, in the same three vertical dots icon, select Template change history, represented by the clock icon.

Create an access group

To create an access group that will limit the tasks that users will be able to interact with in Task Manager, follow the steps below:

  1. On senhasegura, in the upper-left corner, click the Grid Menu, represented by the nine squares, and select Task Manager.

  2. In the side menu, select Settings > Access groups.

  3. In the upper-right corner of the Access groups screen, click the View actions menu, represented by the three vertical dots icon, and select New.

  4. On the Access group registration screen:

    1. Access group name*: enter a human-readable name for the registered access group.
    2. Enabled*: check Yes or No to determine whether the group will be active or inactive.
    3. Description: enter a description for this access group.
    Info

    Synced users will have their permissions overwritten if synchronization is on. Check their synchronization groups for changes.

    1. In the Settings tab:
      1. Requires reason to run task: check the checkbox to require the requester to provide a reason for task execution.
      2. Requires approval to run task: check the checkbox to demand that task execution only occurs upon approval.
      3. Approvals required to run: enter a number indicating the minimum number of approvals required for the requested task execution. This field is enabled only if the Requires approval to run task field is checked.
      4. Disapprovals required to cancel: enter a number indicating the minimum number of rejections required for the requested task execution not to occur. This field is enabled only if the Requires approval to run task field is checked.
      5. Approval in levels: check the checkbox to require the request approval to be done at multiple levels.
      6. User can download the task resulting files: check the checkbox to enable users in the access group to download resulting task files.
      7. User must provide a reason for downloading files resulting by the task: check the checkbox to require users to provide a reason for downloading the resulting task files.
      8. Governance ID required when justifying?*: check Yes or No to define whether users should provide a governance code when justifying the task execution request.
      9. Always add user manager to approvers?*: check Yes or No to define whether the user responsible for the user's department should be automatically consulted as an additional approver for this group and alerted along with the other selected approvers in the Approvers tab.
    Info

    The fields User can download the task resulting files, User must provide a reason for downloading files resulting by the task, and Always add user manager to approvers?* will be removed in future versions.

    1. In the Criteria tab:

      1. Device (comma separated): enter the devices, separated by commas, where the task will be executed.
      2. Environments*: use the checkboxes to select the environments where the task will be executed.
      3. Systems*: use the checkboxes to select the systems where the task will be executed.
    2. In the Users tab:

      1. Users +: click the plus icon to open the System users screen, select the users to be added to the access group, and click Add.
    Attention

    senhasegura works with permission levels. If the user added to the Task Manager access group is in another group with stricter restrictions, they may not be able to view information within the module.

    1. In the Approvers tab:
      1. Approvers +: click the plus icon to open the Approvers screen, select the approvers to be added to the access group, and click Add.
    Attention

    If you have chosen multi-level approval for this access group, after adding at least two approvers, you must define the approval level for each one in the Level column. The chosen level indicates the approval stage at which each approver will be notified after the task execution request.

    Info

    The approver user must have the minimum PAM Operator profile to access the approval workflow screen.

Info

The items with an asterisk are mandatory.

  1. Click Save.
    A pop-up window with the message “Success. Data saved successfully!” confirms the action.

Next

How to manage access groups
How to manage reasons
How to manage tasks

Do you still have questions? Reach out to the senhasegura community.


Was this article helpful?