Enterprise Reporter 3.5.1 - Configuration Manager User Guide

Chat now with support

Node Credential and Alternate Credential Details for On-Premises Discoveries Detailed permissions for Enterprise Reporter discoveries Permissions for Enterprise Reporter discoveries on NAS devices Permissions for Enterprise Reporter tenant applications Logged-In User Credentials Server Service Credentials

Changing the credentials used by the Enterprise Reporter Server

Using the Credential Manager

Changing Passwords Using the Credential Manager Changing Account Names Using the Credential Manager

Setting Up Your First Collection Computers (Nodes)

Configuring Clusters and Nodes for Effective Data Collection Things to Consider Before Creating a Cluster Creating Your First Cluster and Node

Modifying Your Deployment

Managing Clusters

When Do You Add a Cluster? Modifying a Cluster Deleting a Cluster Disabling a Cluster What To Do if a Cluster is Disabled Enabling a Cluster

Managing Nodes

Modifying Node Credentials Modifying the Location of Node Temporary Files Changing a Node to a Different Cluster Removing a Node Why Disable a Node? Stopping a Node Enabling a Node Starting a Node

What does the status of a node or cluster indicate?

Configuring Global Settings

Configuring Change History Configure Logging Credential Manager Database Settings Configuring Email Notifications Registering an Application for Exchange Online Email Delivery

Registering and configuring an application through Azure Active Directory

Managing the Collection of Additional Attributes Configuring IT Security Search Configuring a NAS Host Device Configuring Server Error Notification Managing Tenant Applications Managing the Logon Configuration

Customizing the Configuration Manager View

Understanding Discoveries

Defining the Data Collection (Discoveries) Multi-Factor Authentication Discovery Credential Limitations Best Practices for Creating Discoveries Improving the Performance of Your Discoveries

Adding a Node Improving the Performance of a Node

Discovery Permission Requirements

Detailed permissions for Enterprise Reporter discoveries Permissions for Enterprise Reporter discoveries on NAS devices Permissions for Enterprise Reporter tenant applications CM Understanding Discoveries.04.12.html

Creating Discoveries

Step 1. Create the Discovery (Name)

Configuring Tenant Applications for Cloud Discoveries

Step 2. Choose what to include in your discovery (Scopes)

Scopes: An Overview How Scopes Affect Tombstoning Using the Browser to Include and Exclude Scopes Including Objects in Your Scope Importing Computers to Your Scopes Refining Your Scope with Exclusions Filtering in the Browser Using Queries to Define Your Scopes Using Subnets to Define Your Scopes Using Subnet Credentials

Step 2a. Choose scopes for your on-premises discoveries

Choosing your Active Directory Scopes

AD Discovery: Include scopes AD Discovery: Optionally refine your scope list with exclusions AD Discovery: Optionally select one or more domain controllers AD Discovery: Decide what to collect from any domain in the discovery

Choosing your Computer Scopes

Computer Discovery: Include scopes Computer Discovery: Optionally refine your scope list with exclusions Computer Discovery: Decide what to collect from any computer in the discovery

Choosing Your Exchange Scopes

Exchange Discovery: Include Scopes Exchange Discovery: Optionally refine your scope list with exclusions Exchange Discovery: Optionally select a domain controller Exchange Discovery: Decide what to collect from any server in the discovery

Choosing Your File Storage Analysis Scopes

File Storage Analysis Discovery: Include scopes File Storage Analysis Discovery: Optionally refine your scope list with exclusions File Storage Analysis Discovery: Decide what to collect from any server in the discovery File Storage Analysis Discovery: Configure NAS Host Devices

Choosing Your Microsoft SQL Scopes

MS SQL Discovery: Include scopes MS SQL Discovery: Optionally refine your scope list with exclusions (Scope Exclusions and Global Exclusions)

Choosing Your NTFS Scopes

NTFS Discovery: Best Practices NTFS Discovery: Include scopes NTFS Discovery: Optionally refine your scope list with exclusions NTFS Discovery: Select your global scopes NTFS Discovery: Decide what to collect from any computer in the discovery NTFS Discovery: Configure NAS Host Devices NTFS Discovery: Configure your file collection

Choosing Your Registry Scopes

Registry Discovery: Include scopes Registry Discovery: Optionally refine your scope list with exclusions Registry Discovery: Select your global scopes Registry Discovery: Decide what to collect from any computer

Step 2b: Choose scopes for your cloud discoveries

Choosing Your Azure Active Directory Scopes

Azure AD Discovery: Decide what to collect from the tenant in the discovery

Choosing Your Azure Resource Scopes

Azure Resource Discovery: Include Scopes Azure Resource Discovery: Optionally refine your scope list with exclusions Azure Resource Discovery: Decide what to collect from the subscriptions in the discovery

Choosing Your Exchange Online Scopes

Exchange Online Discovery: Decide what to collect from the tenant in the discovery

Choosing Your Microsoft Teams Scopes

Microsoft Teams Discovery: Include Scopes Microsoft Teams Discovery: Decide what to collect from the subscriptions in the discovery

Choosing Your OneDrive Scopes

OneDrive Discovery: Include Scopes OneDrive Discovery: Optionally refine your scope list with exclusions OneDrive Discovery: Decide what to collect from the drives in the discovery

Choosing Your SharePoint Online Scopes

SharePoint Online Discovery: Include Scopes SharePoint Online Discovery: Optionally refine your scope list with exclusions SharePoint Online Discovery: Decide what to collect from the tenant in the discovery

Step 3. Schedule your Discovery

Run your discovery once Run your discovery on a daily interval Run your discovery on specified days of the week Run your discovery on a specified day of the month Run Your Schedule Yearly Enabling and Disabling Discovery Schedules

Step 4: Review the summary

Managing Discoveries

How is a Discovery Processed?

Types of Tasks Manually Running a Discovery

Viewing your Discoveries

Navigating the Manage Discoveries Pane Viewing the History of a Discovery What Does the Discovery Status Indicate? Viewing the Tasks for a Finished Discovery Viewing the Tasks for a Processing Discovery What Does the Task Status Indicate? Why is My View Empty? Viewing Errors and Error Suppressions Suppressing Discovery Errors Viewing Statistics Viewing a Cluster's Queue

Working with Discoveries and Tasks

Duplicating a Discovery Modifying a Discovery Canceling a Task or Discovery Deleting a Discovery

Troubleshooting Issues with Enterprise Reporter

Problems Opening the Consoles Troubleshooting connectivity issues

Restoring a connection to the Enterprise Reporter Server Restoring a connection to the Enterprise Reporter database

Troubleshooting Connection Timeouts Troubleshooting credential change failures Auditing Enterprise Reporter Activity Resolving Configuration Manager Issues

Node Issues

Node Deployment Issues Dealing with Unassociated Nodes Dealing with Faulted Nodes Problems Deleting a Node Changing the Node Logging Level Changing the Size of the Node Log Files

Scope Enumeration Issues Data Collection Issues

Computer Discovery Errors

Troubleshooting Features in Enterprise Reporter

Exporting Logs from the Configuration Manager Viewing information about your Enterprise Reporter configuration Viewing Errors and Statistics for Tasks

Moving the Enterprise Reporter database Disaster Recovery

Backing up Enterprise Reporter Deploying Enterprise Reporter to another computer after a disaster Checking the Enterprise Reporter configuration after recovery

Appendix: PowerShell cmdlets

What is Microsoft Windows PowerShell? What are cmdlets? Registering Enterprise Reporter cmdlets Adding the snap-ins automatically to new sessions Enterprise Reporter cmdlets Enabling Enterprise Reporter cmdlets Loading the Enterprise Reporter cmdlets Using cmdlets to manage clusters and nodes

Creating a cluster Creating a node Disabling a node Enabling a node Finding a node by name Piping cmdlets Finding a cluster by name Disabling a cluster Enabling a cluster

Using cmdlets to manage discoveries

Getting job information Creating a job Running a job Scheduling a job Deleting a job

Using cmdlets to run reports

Connecting to the server Getting report information Exporting a report definition Importing a report definition to a category Generating a report with data

Appendix: Encryption Key Manager

Starting the Encryption Key Manager Generating a key file Importing a key file Exporting a key file Resetting credentials

Appendix: Log Viewer

Starting the Enterprise Reporter Log Viewer Finding and opening log files Viewing and searching log file entries Filtering log file entries

Getting job information

You probably have configured and run discoveries in the Enterprise Reporter Configuration Manager. These job definitions are useful in understanding how the cmdlets work and provide good examples for you to follow when creating new jobs using cmdlets. The Get-ERJobDefinition cmdlet returns information on the jobs.

Syntax

Get-ERJobDefinition [-ClusterId <Nullable`1[Guid]>] [-ClusterName <String>] [-JobDefinitionName] <String>

Get-ERJobDefinition [-Unassigned [<SwitchParameter>]]

Get-ERJobDefinition -JobDefinitionId <Guid>

Get-ERJobDefinition -JobDefinition <JobDefinition>

Example 1

In this example, information about a job identified with the name of Active Directory is returned.

Get-ERJobDefinition -JobDefinitionName "Active Directory"

Output

JobDefinitionId : ecaae8bb-f0f8-48ee-91ff-da959a937dfa

JobTypeId : bec47934-cadf-4b94-8ff7-68efadc88165

Name : Active Directory

Description :

Configuration : <DiscoveryResolutionTask subType="ActiveDirectory"><Scopes><Scope

type="ActiveDirectory"><Content><Root class="Domain" inex="Include"><Ldap>LDAP:

//AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap><Dns>

AMER.amer.sitraka.com</Dns><DC>AMERGENDC.AMER.amer.sitraka.com</DC>

</Root></Content></Scope></Scopes><Parameters><Parameter

key="GatherSharedEntities"><Value>False</Value></Parameter><Parameter

key="CollectDCs"><Value>True</Value></Parameter><Parameter

key="CollectAccounts"><Value>True</Value></Parameter><Parameter

key="CollectComputers"><Value>True</Value></Parameter><Parameter

key="CollectOUs"><Value>True</Value></Parameter><Parameter

key="CollectSites"><Value>True</Value></Parameter><Parameter

key="CollectTrusts"><Value>True</Value></Parameter><Parameter

key="CollectPhysicalComputerInfo"><Value>False</Value></Parameter><Parameter

key="FindForeignMember"><Value>False</Value></Parameter><Parameter

key="SyncLogon"><Value>False</Value></Parameter><Parameter

key="CollectPermissions"><Value>False</Value></Parameter><Parameter

key="CollectRemoteServices"><Value>False</Value></Parameter><Parameter

key="CollectPhotosForUsers"><Value>False</Value></Parameter>

</Parameters></DiscoveryResolutionTask>

AssignedClusterId : af0e6da4-10b9-4b20-bf5a-f19f0d71b589

CredentialId :

AssignedClusterName : First Cluster

IsTombstoned : False

Schedule : <Trigger Type="RunOnceTrigger" StartDateTime="2014-07-14T13:50:00Z"

Expression="2014-07-14 13:50:00Z@0 50 13 14 7 ? 2014" />

NextRun :

Example 2

In this example, information about all the jobs (the * wildcard is used in -JobDefinitionName) located on the cluster named Second Cluster is returned.

Get-ERJobDefinition -ClusterName "Second Cluster" -JobDefinitionName *

Output

JobDefinitionId : 7a8d758b-15e8-4f84-a30e-1c8545eed4f5

JobTypeId : bec47934-cadf-4b94-8ff7-68efadc88165

Name : Computer

Description :

Configuration : <DiscoveryResolutionTask subType="Computer"><Scopes><Scope type="Computer">

<Content><Rootclass="Domain" inex="Include"><Ldap>LDAP://AMER.amer.sitraka.com

/DC=RPTCH,DC=dev,DC=hal,DC=ca,DC=qsft</Ldap><Dns>AMER.amer.sitraka.com

</Dns></Root></Content></Scope></Scopes><Parameters><Parameter

key="GatherSharedEntities"><Value>False</Value></Parameter><Parameter

key="CollectAccounts"><Value>True</Value></Parameter><Parameter

key="CollectEventLogConfig"><Value>True</Value></Parameter><Parameter

key="CollectPolicies"><Value>True</Value></Parameter><Parameter

key="CollectPrinters"><Value>True</Value></Parameter><Parameter

key="CollectServices"><Value>True</Value></Parameter><Parameter

key="CollectShares"><Value>True</Value></Parameter><Parameter

key="CollectVolumes"><Value>True</Value></Parameter><Parameter

key="CollectExtendedWMIEntities"><Value>True</Value></Parameter><Parameter

key="PingTimeout"><Value>0</Value></Parameter></Parameters>

</DiscoveryResolutionTask>

AssignedClusterId : 390b0bd1-6488-4ace-b2cc-616925b55c06

CredentialId :

AssignedClusterName : Second Cluster

IsTombstoned : False

Schedule : <Trigger Type="RunOnceTrigger" StartDateTime="2014-07-15T13:58:00Z"

Expression="2014-07-15 13:58:00Z@0 58 13 15 7 ? 2014" />

NextRun :

As you can see in these examples, there is a lot of information contained in the job definition. The largest and seemingly most complicated part is the configuration, which contains all of the information about the jobs that you created using the Discovery Wizard. For more information about the configuration, see Creating a job.

Creating a job

Using cmdlets to create a new job requires planning as there is a lot information contained in a job definition. You would use cmdlets to automate a process, such as cloning a current job or creating a new job in an environment with limited resources.

Syntax

New-ERJobDefinition [-Name] <String> [-JobType] <String> [-Configuration] <String> [[-ClusterId] <Guid>] [[-CredentialId] <Guid>] [[-Description] <String>] [[-Schedule] <String>] [[-NextRun] <Nullable`1[DateTime]>] [-PassThru [<SwitchParameter>]]

•

[-JobType] values are: ActiveDirectory, Computer, Exchange, MS SQL, NTFS, and Registry.

•

[-Configuration] is the XML representation of the job or discovery configuration. See any of the job examples in the Getting job information section, which discussed the Get-ERJobDefinition cmdlet. This is the best way to get a configuration to use in creating a job manually.

The configuration can be contained in an XML file, making it easier to navigate. Using Notepad, copy the configuration from an existing job and paste it into a file. It is recommended that you create default files with the extension .XML and have the format as seen below which makes it easier to go thru and make the setting you want to make.

Do not use any special program that provides an XML format. Any additional data in the file will not be interpreted correctly and can cause errors with the job creation. Use Notepad to avoid unseen character formatting.

Example 1

As you can see in this example, each section of the XML file has an opening and a closing statement. When you are working with a copy of the configuration from the Get-ERJobDefinition cmdlet, pay attention to spaces, text, slashes, and other characters, as missing or extra characters will cause an issue with the job.

<Ldap>LDAP://AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap>

<Dns>\\AMERGEN02.AMER.amer.sitraka.com</Dns>

</DiscoveryResolutionTask>

Example 2

In this example, the contents of the XML configuration file is used with the New-ERJobDefinition cmdlet. The values for the -Configuration parameter are enclosed in a single quote mark (').

The parameters in this example are formatted to make it easier for you to read. When running the cmdlet, the parameters cannot contain any carriage returns in the command line. If you want to use this example, you must first paste it into NotePad and remove the carriage returns.

New-ERJobDefinition -Name "NTFS All" -JobType NTFS -Configuration '<DiscoveryResolutionTask subType="NTFS"><Scopes><Scope type="NTFS"><Content><Root class="Domain" inex="Include"><Ldap>LDAP://AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap><Dns>AMER.amer.sitraka.com</Dns></Root></Content></Scope></Scopes><Parameters>

<Parameter key="CollectPublicShares"><Value>True</Value></Parameter><Parameter

key="TreatSharesAsShares"><Value>True</Value></Parameter><

Parameter key="CollectFolderPermissions"><Value>True</Value></Parameter><Parameter

key="CollectChildACLDifferences"><Value>True</Value></Parameter><Parameter

key="FolderDepth"><Value>-1</Value></Parameter><Parameter

key="GatherSharedEntities"><Value>False</Value></Parameter><Parameter key="GlobalInclude"/><Parameter

key="GlobalExclude" /><Parameter key="CollectFiles"><Value>True</Value></Parameter><Parameter

key="CollectFilePermissions"><Value>True</Value></Parameter><Parameter

key="CollectOnlyExplicitFilePermissions"><Value>False</Value></Parameter><Parameter

key="IncludeFile"><Value>*.*</Value></Parameter><Parameter

key="PingTimeout"><Value>0</Value></Parameter></Parameters></DiscoveryResolutionTask>'

-ClusterId af0e6da4-10b9-4b20-bf5a-f19f0d71b589 -Schedule '<Trigger Type="RunDailyTrigger"

StartDateTime="2014-07-17T04:00:00Z" Expression="2014-07-1704:00:00Z@0 0 4 1/2 * ?" EveryNDay="2" />'

Example 3

In this example the configuration is in an XML file, which allows changes to be made to the configuration when using the cmdlets. The XML files are just simple files that can be edited using Notepad and do not require any special formatting. The configuration of any current job is in the XML format and can be used as a template.

$filepath = "c:\configuration.xml"

$configuration =[string]::join([environment]::newline, (get-content -path $filepath))

$foundCluster = Get-ERCluster 'First Cluster'

New-ERJobDefinition -Name NTFS10 -JobType NTFS -Configuration $configuration –ClusterId $foundCluster.ClusterId

Example 4

In this example, you want to clone a current job. The important item to note is that the -Name parameter needs to be changed to a unique value. The first cmdlet Get-ERJobDefinition gets the data on the job you wish to clone. In the New-ERJobDefinition cmdlet you use the data in the configuration of the cloned job by using $JobDefinition.Configuration to supply the needed configuration for the new job.

$JobDefinition = Get-ERJobDefinition "NTFS All"

$foundCluster = Get-ERCluster 'First Cluster'

New-ERJobDefinition -Name NTFS2 -JobType NTFS -Configuration $JobDefinition.Configuration -ClusterId $foundCluster.ClusterId

Running a job

Now that you have a job or two you need to run them to retrieve data from your environment by sending a job to the Enterprise Reporter server for immediate execution. Depending on what is processing within the server, the job may be queued to run at the next available time. This is different than scheduling a job which is discussed later.

Syntax

Submit-ERJobDefinition [-JobDefinitionId] <Guid>

Submit-ERJobDefinition [-JobDefinition] <JobDefinition>

Example 1

In this example, the job or discovery identified by the JobDefinitionId ecaae8bb-f0f8-48ee-91ff-da959a937dfa is submitted for immediate processing. If the job starts, True is returned.

Submit-ERJobDefinition -JobDefinitionId ecaae8bb-f0f8-48ee-91ff-da959a937dfa

Example 2

In this example, the information about the job definition retrieved by the Get-ERJobDefinition cmdlet is piped to the Submit-ERJobDefinition cmdlet, so the job starts immediately. If the job starts, True is returned.

Get-ERJobDefinition "Active Directory" | Submit-ERJobDefinition

Scheduling a job

You may want to change the start time for a scheduled job because it conflicts with another job.


	NOTE: The schedule must be in CRON format. The time are UTC or GMT (time zone Z (zulu)).

Syntax

Set-ERJobDefinitionSchedule [-JobDefinitionId] <Guid> [[-Schedule] <String>]

Set-ERJobDefinitionSchedule [-JobDefinition] <JobDefinition> [[-Schedule] <String>]

Set-ERJobDefinitionSchedule [-JobDefinitionName] <String> [[-Schedule] <String>]

Example 1

This is an example of a Run Once job set to start at a specific date and time. First, the job is placed into the $discovery variable using the Get-ERJobDefinition cmdlet. Second, the Set-ERJobDefinitionSchedule cmdlet is executed with a different time and date for the job. Note the single quote that encloses the time.

$discovery = get-ERJobDefinition "Active Directory"

Set-ERJobDefinitionSchedule $discovery.JobDefinitionId '<Trigger Type="RunOnceTrigger" StartDateTime="2014-07-15T16:50:00Z" Expression="2014-07-15 16:50:00Z@0 50 16 15 7 ? 2014" />'

Example 2

This is an example of a Run Daily job set to start at a specific date and time, and to run every day.

Set-ERJobDefinitionSchedule -Schedule '<Trigger Type="RunDailyTrigger" StartDateTime="2014-05-27T14:40:00Z" Expression="2014-05-27 14:40:00Z@0 40 14 1/1 * ?" EveryNDay="1" />'

Example 3

This is an example of a Run Daily job set to start at a specific date and time, and to run every 4th day.

Set-ERJobDefinitionSchedule -Schedule '<Trigger Type="RunDailyTrigger" StartDateTime="2014-05-28T16:04:00Z" Expression="2014-05-28 16:04:00Z@0 4 16 1/4 * ?" EveryNDay="4" />'

Example 4

This is an example of a Run Weekly job set to start at a specific date and time, and to run on Monday, Wednesday, and Friday.

Set-ERJobDefinitionSchedule -Schedule '<Trigger Type="RunWeeklyTrigger" StartDateTime="2014-05-30T16:01:00Z" Expression="2014-05-30 16:01:00Z@0 1 16 ? * MON,WED,FRI" RunOnWeekDays="21" />'

Example 5

This is an example of a Run Monthly job set to start at a specific date and time and to run on the 1st Wednesday of the month.

Set-ERJobDefinitionSchedule -Schedule '<Trigger Type="RunMonthlyTrigger" StartDateTime="2014-06-03T16:02:00Z" Expression="2014-06-03 16:02:00Z@0 2 16 3 * ?" MonthlyScheduleType="NthDayOfTheMonth" WeekType="First" WeekDay="Wednesday" DayOfTheMonth="3" />'

Example 6

This is an example of a Run Monthly job set to start at a specific date and time on the 3rd Wednesday of the month.

Set-ERJobDefinitionSchedule -Schedule '<Trigger Type="RunMonthlyTrigger" StartDateTime="2014-06-18T16:02:00Z" Expression="2014-06-18 16:02:00Z@0 2 16 ? * WED#3" MonthlyScheduleType="NthDayOfTheNthWeek" WeekType="Third" WeekDay="Wednesday" DayOfTheMonth="28" />'

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Enterprise Reporter 3.5.1 - Configuration Manager User Guide

Getting job information

Creating a job

Running a job

Scheduling a job