Chatta subito con l'assistenza
Chat con il supporto

Enterprise Reporter 3.5.1 - Report Manager User Guide

Quest Enterprise Reporter Report Manager Introducing the Report Manager Running and Scheduling Reports Creating and Editing Reports Troubleshooting Issues with Enterprise Reporter Appendix: PowerShell cmdlets

Using cmdlets to manage discoveries

An important aspect of Enterprise Reporter, discoveries return information about the systems in your environment. Discoveries gather data about Active Directory, computers, SQL Server, and NTFS permissions for files and folders. When using Enterprise Reporter cmdlets, discoveries are referred to as jobs. The examples in this section demonstrate how to create and run jobs using cmdlets.

This section contains the following examples:

•
Getting job information
•
Creating a job
•
Running a job
•
Scheduling a job
•
Enabling a cluster

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.

<DiscoveryResolutionTask subType="NTFS">
<Scopes>
<Scope type="NTFS">
<Content>
<Root class="Computer" inex="Include">
<Ldap>LDAP://AMER.amer.sitraka.com/DC=AMER,DC=amer,DC=sitraka,DC=com</Ldap>
<Dns>\\AMERGEN02.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>
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
Related Documents

The document was helpful.

Seleziona valutazione

I easily found the information I needed.

Seleziona valutazione