Cohesity ServiceNow Integration-User Guide
Cohesity ServiceNow Integration-User Guide
User Guide
Version 5.1.2
ABSTRACT
The Cohesity ServiceNow (SNOW) plugin integrates ServiceNow with Cohesity DataPlatform. The main
goal of this plugin is to execute the workflows of the Cohesity Data Platform such as data protection,
cloning and recovery from ServiceNow. The ServiceNow plugin also lets you manage alerts using webhooks
which is a common and an important part of IT Service Management (ITSM).
The Cohesity ServiceNow Integration Installation and Configuration Guide describes the process to help
you set up and configure the SNOW plugin.
Contents
Introduction 4
Audience 4
Plugin Requirements 5
Features 5
What’s New 6
Latest Release: v5.1.2 6
Previous Releases 6
Software Requirements 7
Process Overview 7
Inventory Management 8
Role-Based Access Control 8
CI Relationship and Dependency Views 9
Cohesity SNOW Tasks 13
Cohesity Catalog 13
Protection Source 14
Data Protection 14
Recovery/Clone 14
SNOW Workflows 15
Register a Source 15
Unregister a Source 16
Create New Protection Job 16
Environment: vCenter 16
Environment: Physical Server (block-based) 16
Environment: Physical Server (file-based) 17
Environment: MSSQL Database 17
Environment: Oracle Database 17
Protect VM 17
Cohesity DataPlatform integrates with ServiceNow through the REST API to simplify data protection and
data management on VMs including workflow automation, backup, and recovery and so on.
Audience
The reader of the Cohesity SNOW plugin guide must be familiar with the following:
Features
The Cohesity ServiceNow plugin offers the following features:
● Supports a multi-cluster environment
● Inventory Management
● Availability of Service Catalog with Protection Source, Data Protection, and Recovery and Clone
workflows
Note: The workflows are supported for vCenter and physical sources
● Option to register and unregister a vCenter and physical server
● Workflow Management such as protect VMs, recover VMs, clone VMs, recover files and folders,
and creating protection jobs
● CI Relationships between the relevant resources
● Incident management & Event management through Webhooks
Previous Releases
VERSION WHAT’S NEW REVISION DATE
v5.1.1 ● Fixed an issue related to discovery of cluster resources July 2022
Fixed an issue in sending webhook/incident management to
the instance
v5.1 ● Supports MSSQL and Oracle database workflows April 2022
v5.0 ● Inventory Management December 2021
● Cluster Summary
● CI Relationships
● RBAC support for VMware environment
● Removed dependency of Event Management
v4.2 ● Cohesity alert management through ServiceNow Incident January 2021
or Event
v4.1 ● Option to schedule the recovery and clone workflow at a July 2020
specific time slot
● Optimization of the search files/folders results
● Displaying the file size while restoring the file/folder
● Resolving alerts through ServiceNow on a multi-node
cluster environment
● Few minor bug fixes
v4.0 ● Cohesity Alert Management through Webhook April 2020
configuration
● Simplified cluster synchronization and discovery
processes
● Service Catalog for workflow process
Software Requirements
COHESITY SNOW
SERVICENOW RELEASE
PLUGIN VERSION COHESITY DATAPLATFORM
VERSION
Note:
● Alert management using Webhook is supported in Cohesity cluster version 6.3.x or higher
● Webhook/Incident management is not supported in Cohesity cluster version 6.5 and 6.5.1
Process Overview
The overall process of working with the SNOW plugin is as follows:
1. Install the Cohesity SNOW plugin along with the MID server configuration
2. Add ServiceNow users and assign to appropriate groups
Inventory Management
Inventory Management helps you view the configured cluster information and discover the available
sources. It summarizes information with cluster versions, storage capacity, DNS types, node IPs, etc.
The user can view the information through the following within Inventory Management:
● Cluster Summary: The Cluster Summaries view lists all the configured and available cluster
summaries under ServiceNow.
● Cluster Nodes: The Cluster Nodes View lists all the nodes present in the available clusters.
● Protection Sources: The Inventory Sources View lists all the registered protection sources on the
configured Cohesity clusters irrespective of the environment type.
NOTE: Assigned group should be a part of Cohesity User group, in order to access the cohesity application
and resources assigned to them.
The dependency views map shows the relationship between Protection Jobs with its protected objects
and job run details.
Cohesity Catalog
Service Catalog is a structured collection of catalog items and a consumable view of available services and
offerings managed by an organization, which describes the list of services that the plugin is providing for
the user including those available for Deployment.
The Cohesity Catalog is a collection of services available such as Protection Source, Data Protection, and
Recovery/Clone. To access this, type Cohesity in the search bar, and navigate to Cohesity Application >
Cohesity Catalog.
● Protection Source: Register or Unregister a Protection Source on the Cohesity Cluster. It could be
the root node of a vCenter Server, a Physical Server or Database(MSSQL & Oracle).
● Data Protection: End-to-end protection for your Virtual server, Physical server, Oracle database
and MS SQL database with a single, simple web-scale solution.
● Recovery/Clone: Provide services to Recover/Clone Virtual Machines and Databases (Oracle/SQL),
which have been protected.
You can register or unregister vCenter and physical servers using the Protection Source catalog as
follows. The protection source can be the root node of a vCenter server or a physical server.
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Cohesity Catalog
2. Click Protection Source
3. Select the environment category as Physical Server, VMware, MSSQL, or Oracle based on the
environment of the source to be registered/unregistered.
4. Select the operation to be performed:
● VMware: Register Source or Unregister Source
● Physical Server: Register Source or Unregister Source
● MSSQL: Register Source or Unregister Source
● Oracle: Register Source or Unregister Source
Data Protection
You can perform various operations such as create protection jobs, delete jobs, protect virtual machines
and unprotect virtual machines.
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Cohesity Catalog
2. Click Data Protection
3. Select the environment category either as Physical Server, Virtual Server, MSSQL, or Oracle based
on the environment of Protection job
4. Select the operation to be performed:
● Virtual Server: Create New Protection Job, Delete Job, Protect Virtual Machine or Unprotect
Virtual Machine
● Physical Server: Create New Protection Job or Delete Job
● MSSQL: Create New Protection Job or Delete Job
● Oracle Create New Protection Job or Delete Job
Recovery/Clone
You can perform recovery or clone operations on virtual machines and databases.
NOTE: This service is only applicable for Virtual Machines and Databases(MSSQL & Oracle).
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Cohesity Catalog
2. Click Recovery/Clone
3. Select the operation to be performed:
SNOW Workflows
You can execute various SNOW workflows as described in the below procedures. After you execute
a workflow, it will be sent as a request for approval or will be approved directly. This depends on
the configurations enabled for approvals while configuring a cluster. See Configure Cohesity
clusters in Cohesity ServiceNow Integration Install and Configuration Guide. Users belonging to a
group with the necessary privileges to approve the requests can approve the SNOW execution
requests.
Note: Users associated with the Cohesity Admin or Cohesity User group only will be able to perform
the below tasks.
Register a Source
You can choose to register a source as a Hypervisor or Physical Server.
1. Type Cohesity in the search bar. Navigate to Protection source > Source and click Register
2. Select the cluster in which the source to be registered in the Cluster drop-down list
3. To register Hypervisor source:
a. Select Hypervisor as the Environment and vCenter as Source Type
b. Enter the Source information such as Host IP address of the vCenter, Username and Password
for authentication
4. To register Physical Server Source:
a. Select Physical Server as the Environment
b. Enter the Source Information such IP address of the physical server and Host type of the server
either Linux/Windows
5. To register MSSQL:
a. Select MSSQL as the Environment
b. Enter the Source Information of the MSSQL database.
6. To register Oracle
a. Select Oracle as the Environment
b. Enter the Source Information of the Oracle database.
7. Click Order now.
8. A request is submitted for the catalog item. If approval was enabled for this action in the
configuration page, then the requested item will wait for approval from the user with the
respective group (Cohesity Source)
Unregister a Source
Discovered source of environment type vCenter, Physical Server, MSSQL, and Oracle can be unregistered.
After unregistering the source, all the associated resources of the source will be removed from the CMDB
table.
1. Type Cohesity in the search bar. Navigate to Sources > Protection Source
2. Select the source (either Physical Server or VMware, MSSQL, Oracle) that must be unregistered
3. Click Unregister and click Ok in the confirmation prompt
4. Click Order now
5. A request is submitted for the catalog item. If approval was enabled for this action in the
configuration page, then the requested item will wait for approval from the user with the
respective group (Cohesity Source)
6. To approve the request, log in to the instance using any of the users within the Cohesity Source
group. See Execute Approvals for details
1. Type Cohesity in the search bar. Navigate to Protection Jobs > Protection Jobs and click New Job
2. Once the respective catalog item page is loaded, select the Cluster where the Protection job
needs to be created for the available source.
3. Provide the name for the protection job.
4. Make a selection to protect either vCenter, physical server (block-based or file-based), MSSQL,
or Oracle.
Environment: vCenter
● For auto-protecting the source with a higher source level, select Auto Protect as Yes. Then
select the protection level (Source/DataCenter/Compute Resource/ESXI Host) and select
the corresponding source in the populated source dropdown, to be auto protected.
● For standalone protection of a Virtual Machine, select the corresponding source and ESXI
host information.
● Select the Virtual Machine(s) to be protected by moving them from the Available list to the
selected VM(s) list or double click on the Virtual Machine(s) to be protected.
Protect VM
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Virtual Machines > Virtual
Machines List.
2. Select the Virtual Machine(s) to be protected and click Protect
3. Select the protection job from the drop down through which the selected virtual machine(s) need
to be protected.
4. Click Order Now
5. A request is submitted for the catalog item. If approval was enabled for this action in the
configuration page, then the requested item will wait for approval from the user with the
respective group (Cohesity ProtectVM)
6. To approve the request, log in to the instance using any of the users within the Cohesity
ProtectVM group. See Execute Approvals for details
Unprotect VM
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Virtual Machines > Virtual
Machines List
2. Select the Virtual Machine(s) to be unprotected
NOTE:
a. Only protected Virtual machines can be selected for unprotecting
b. Virtual Machines from different clusters are not allowed to unprotect at same time
c. Virtual Machines from different protection jobs are not allowed to unprotect at same time
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Protection Jobs >
Protection Jobs
Recover VM
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Recover > Recover VM
2. Select a virtual machine to be recovered and click Recover VM
Note: Only one VM can be selected at a time for recovery. If multiple VMs are selected, an alert
displays.
3. Select the Recover Points for the snapshot of virtual machines to be recovered
4. If the recovered VM name to be renamed, then enable ‘Rename Recovered VMs’ option
and provide the Suffix and Prefix value
5. Enable Change Recover Options to relocate the recovered VM into a new location and
provide the source details, where the recovered VM needs to be relocated.
6. In case of attaching a new network to the recovered VM, select ‘Attach to new network’
option in the Networking Options and select the network to be attached. This is applicable
only when the VM is recovered in new location
7. To schedule the restore workflow, enable the option Schedule the Restore, and select the
appropriate time slot in the Scheduled Date field
8. Click Order Now
9. A request is submitted for the catalog item. If approval was enabled for this action in the
configuration page, then the requested item will wait for approval from the user with the
respective group (Cohesity RecoverVM)
10. To approve the request, log in to the instance using any of the users within the Cohesity
RecoverVM group. See Execute Approvals for details
Clone VM
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Clone > Clone VM
2. Select a virtual machine to be cloned and click Clone VM
Note: Only one VM can be selected at a time for cloning. If multiple VMs are selected, an alert
displays.
Move VM
1. Type Cohesity in the search bar. Navigate to Virtual Machines List > Virtual Machines
2. Select a virtual machine that is already Protected, and in the Virtual Machines detail page,
click Move to another Protection job
Note: This option will not be available for virtual machines which are not protected.
3. In the Move VM catalog page, the current protection job field contains the list of protection jobs
by which the selected Virtual Machine is protected. Select the New Protection Job to which the
VM must be moved for protection.
4. Click Order Now.
5. A request is submitted for the catalog item. If approval was enabled for this action in the
configuration page, then the requested item will wait for approval from the user with the
respective group (Cohesity MoveVM)
6. To approve the request, log in to the instance using any of the users within the Cohesity MoveVM
group. See Execute Approvals for details
Recover Database
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Recover > Recover
Database
2. Select a database to be recovered and click Recover Database
Note: Only one database can be selected at a time for recovery. If multiple databases are selected,
an alert displays.
Clone Database
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Clone > Clone
Database
2. Select a database to be cloned and click Clone Database.
Note: Only one database can be selected at a time for cloning. If multiple databases are selected,
an alert displays.
Run Job
1. Type Cohesity in the search bar. Navigate to Cohesity Application > Protection Jobs >
Protection Jobs.
2. Select the Protection to run.
3. Click Run Job.
4. On running the job in SNOW, it will call the corresponding REST API call to trigger the Protection
Job in the respective Cohesity Cluster.
Recover Files/Folders
You can either search for specific files/folders and then proceed to choose files/folders for recovery or
directly click Recover Files/Folders option and then choose files/folders for recovery if the file/folder is
already discovered through the search option.
5. Select the recovery points for the file/folder which have to be used for recovery
6. If the file/folder must be recovered to a different source, select the Server Name from the
list and provide the username and password of the selected source (in case if the source
type is Virtual Server)
7. If the file must be recovered to a different location, then select Recover to original location
to No and provide the Recover location
8. To schedule the clone workflow, enable the option Schedule the Cloning, and select the
appropriate time slot in the Scheduled Date field
9. Click Order Now.
10. A request is submitted for the catalog item. If approval was enabled for this action in the
configuration page, then the requested item will wait for approval from the user with the
respective group (Cohesity RecoverFile)
11. To approve the request, log in to the instance using any of the users within the Cohesity
RecoverFile group. See Execute Approvals for details
1. In the Search box, type Cohesity and select My Approvals under Requested/Approvals
3. Update the request by providing comments in the Comments field, and click on
Approve/Reject
4. After the request is approved, you can view the updated data in the Cohesity DataPlatform
On resolving the incident, it will call the corresponding REST client API to start the process for resolving
the selected incident in the Cohesity Cluster and display the status message of the resolution process.
Resolve Event
Before resolving an event, ensure that the corresponding business rule is activated. To activate business
rules,
1. Login to ServiceNow instance
2. Navigate to System Definition > Business Rules
3. Search for CohesityResolveAlert
4. Click on Active and save the business rule
Dashboard
The Cohesity Dashboard will be visible to those with the role of Cohesity Admin or Cohesity User
group. You can choose a cluster from the drop down to display details specific to that cluster in the
Dashboard.
This can be done either manually in the cohesity cluster or through Update Webhook option available
for each configured cluster in the Configuration module.
About Cohesity
Cohesity ushers in a new era in data management that solves a critical challenge facing businesses today:
mass data fragmentation. The vast majority of enterprise data — backups, archives, file shares, object
stores, and data used for dev/test and analytics — sits in fragmented infrastructure silos that makes it
hard to protect, expensive to manage, and difficult to analyze. Cohesity consolidates silos onto one web-
scale platform, spanning on-premises, cloud, and the edge, and uniquely empowers organizations to run
apps on that platform — making it easier than ever to back up and extract insights from data. Cohesity is
a 2019 CNBC Disruptor and was named a Technology Pioneer by the World Economic Forum.
Visit our website and blog, follow us on Twitter and LinkedIn and like us on Facebook.
Cohesity, the Cohesity logo, SnapFS, SnapTree, SpanFS, and SpanOS, are registered trademarks, and DataPlatform, DataProtect, and Helios are
trademarks of Cohesity, Inc. All rights reserved.
2000026-001-EN