Tenjin Icon

Installing and configuring JobR

mceclip0.png

This article covers the following:

Installation

The JobR application is available on the ServiceNow app store. From here, a ServiceNow administrator can install it in a production environment or take a trial in a non-production environment. All the activities described below need to be performed by a ServiceNow administrator.  

System Requirements/Prerequisites

  • MID Server. You must have a working Windows MID Server on the instance. When you create a new Data Source, you will have the option to specify which MID Server to use. Please see the section on MID Security Policy. The MID Server must be able to access the servers you wish to collect data from.  
  • For each data protection system that will be included in JobR, the relevant admin must provide credentials for an admin account and the REST API URL 
  • JobR supports Veritas NetBackup (minimum version:8.3) and Veeam Enterprise Manager (minimum version:11) 
  • NetBackup
    It is recommended to use API Key authentication
    The NetBackup admin must obtain the API key for an administrator-level account and provide the REST API URL (typically https://masterserverURL) 
  • Veeam
    Veeam uses basic auth.
    The Veeam Enterprise Manager admin will provide the credentials (user ID and password) for an admin-level account and the Veeam EM REST API URL (typically https:/VeeaEMURL:9838).
  • Commvault: It is recommended to use basic authentication. The core Commvault URL (typically https://cellname) is required along with credentials (userid and password) for an administrator-level account. The password needs to be base64 encoded, you can use an online encoding site like Base64 Encode and Decode - Online
  • Cohesity: It is recommended to use basic authentication. The core Cohesity URL (typically https://clustername) is required along with credentials (userid and password) for an administrator-level account. 
  • Additional Information may be required from a Data Management administrator.  

Once the app is installed please make the following changes to roles shipped by the app:

  • Create the following 2 jobr groups: JobR Users and Jobr Admins
  • Add roles canvas_user and x_biomn_jobr.user  to JobR Users
  • Add roles canvas_user, connection_admin, credential_admin and x_biomn_jobr.administrator to Jobr Admins
  • Assign Jobr Users to the respective user group

Minimum Configuration

A data source within JobR represents the system from which JobR will extract information. The REST API URL and associated administrator credentials for the data source are stored as ServiceNow Connections and Credentials aliases. These will need to be configured before the data source can be used. 

Configuration

A Connection and Credential Alias is required for each Backup system you are connecting to. It defines how JobR connects to and authenticates against the REST API of a Brackup system. 

Create a Connection & Credential Alias

  1. Select “Connections & Credentials>Connection & Credential Aliases” from the left-hand menu.
  2. Click New to create a new alias.
  3. Give it a name (this is what will be visible in JobR) and leave the other fields at their default values. 
  4. Click Submit. 

Create a Credential

  1. Select Connections & Credentials>Credentials from the left-hand menu.
  2. For NetBackup, select “API Key Credentials” from the list, enter a name, and paste in the API Key from NetBackup. 
  3. For Veeam, select “Basic Auth Credentials” from the list, enter a name and the user name/password pair created in Veeam. 
  4. Click Submit.

Create a Connection

  1. Select Connections & Credentials>Connections from the left-hand menu.
  2. Select “HTTP(s) Connection” from the list.
  3. Enter a name and select previously created Alias above.
  4. Enter the URL of the backup server in the “Connection URL” field and check “Use MID Server”.
  5. Click Submit

Configure JobR Data Source 

  1. Select JobR>Configuration>Data Sources from the left-hand menu.
  2. Click New and fill in the Name field and check the Active box.
  3. Select the Technology (this must match the “Connection & Credential Alias”).
  4. Select the Alias created above in the “Connection & Credential Alias” field.
  5. Click Submit to create the Data Source or Test Connectivity.  

Enable Job Failure Data Collection

  1. Select JobR>Configuration>Data Sources from the left-hand menu.
  2. Open the Data Source previously created.
  3. In the “Data Collectors” tab, click Edit.
  4. Select “Get Job Failures” from the left-hand list and move to the right.
  5. Click Save. 

The Data Collector process runs every ten minutes although you can force its execution through the Data Collectors menu item.

Mid Security Policy 

If your internal Backup Server does not have signed certificates you need to make a change in the ServiceNow setting for the MID Servers. 

  1. Select MID Service>MID Security Policy from the left-hand menu.
  2. Select Intranet.
  3. Untick “Certificate Chain Check” and “Hostname Check” blobid0.png

Resetting Data

  1. Select JobR>Data Collectors from the left-hand menu.
  2. Select the “Get Job Failures” data collectors.
  3. Click the “Clear Data” link and the “Execute” button.
  4. All failed job data will be cleared in and re-imported.
  5. View the job failures in JobR>Job Failures page. 

JobR User Roles

Two user roles exist within JobR. Your ServiceNow administrator assigns both;

Administrator: x_biomni_jobr.administrator. A user with this role has complete access to the JobR app. 

User: x_biomni_jobr.user. A user with this role type can monitor and action failed jobs. They cannot create data sources, rules, or actions.  

Once the app is installed please make the following changes to roles shipped by the app: 

  • Create the following 2 jobr groups: JobR Users and Jobr Admins
  • Add roles canvas_user and x_biomn_jobr.user  to JobR Users
  • Add roles canvas_user, connection_admin, credential_admin and x_biomn_jobr.administrator to Jobr Admins
  • Assign Jobr Users to the respective user group

Accessing JobR

Direct access to JobR

JobR is accessed via a ServiceNow workspace. To access the workspace login directly into the JobR Workspace (https://yourcompany.service-now.com/x/biomn/jobr/home). 

Through the classic ServiceNow UI

To get to the JobR workspace from the classic ServiceNow UI, search for JobR to find its menu and submenus

mceclip2.png

 

 

Share this article

Comments

0 comments

Article is closed for comments.