You are here:

Create an Inventory Job Definition - NetApp ONTAP File

Cataloging objects located on a provider is required for browsing, searching, and reporting in ECX.

A NetApp ONTAP File Inventory job provides the framework to catalog and collect information about low-level NetApp ONTAP objects. You can select one or more NetApp ONTAP providers in a single job definition for cataloging. NetApp ONTAP 7-Mode and Cluster-Mode are both supported.

During cataloging, properties for NetApp ONTAP files are collected and stored. Run a NetApp ONTAP File Inventory job y to analyze your low-level NetApp ONTAP environment in real time and navigate and correlate the objects from across the Enterprise in a single view. Additionally, you can infer snapshot sprawl, storage overutilization, and other storage inefficiencies.

Note: For cataloging high-level NetApp ONTAP objects, create a NetApp ONTAP Storage Inventory job definition.

Tip: NetApp ONTAP File Inventory jobs may take a long time to run because they catalog at a file level. Consider creating NetApp ONTAP File Inventory job definitions that constrain the number of file system objects to catalog by limiting the number of storage systems and volume processed by a single job. You can also stagger the scheduled run times of the jobs to prevent them from running concurrently. Consider running NetApp ONTAP File Inventory jobs less frequently than you run NetApp ONTAP Storage Inventory jobs.

BEFORE YOU BEGIN:

At least one NetApp ONTAP provider must be associated with a NetApp ONTAP File Inventory job definition. Before defining an Inventory job, add NetApp ONTAP providers. See Register a Provider.
For email notifications, at least one SMTP server must be configured. Before defining a job, add SMTP resources. See Register a Provider.

CONSIDERATIONS:

One or more schedules might also be associated with a job. Job sessions run based on the triggers defined in the schedule. See Create a Schedule.

Best Practice: Create a schedule before creating a job definition so that you can easily add the schedule to the job definition.

To create a NetApp ONTAP File Inventory job definition:

Click the Jobs tab. Expand the Storage Controller folder, then select NetApp ONTAP.
Click New , then select Inventory NetApp ONTAP Files. The job editor opens.
Enter a name for your job definition and a meaningful description.
From the list of available sites, select one or more volumes to catalog. For Cluster-Mode providers, the SVM name appears in parentheses after the volume name. To view the number of files on the selected volume, hover your cursor over the volume name.
To create the job definition using default options, click Create Job. The job can be run manually from the Jobs tab.
To edit options before creating the job definition, click Advanced. Set the job definition options.
Maximum concurrent tasks
Set the maximum number of concurrent cataloging tasks that can be performed on the provider.
Skip root volume
Select this option to avoid cataloging the root volume of your NetApp ONTAP objects.
Skip unsupported volumes
Select this option to avoid cataloging unsupported volumes such as volumes that are offline. Selecting this option also avoids cataloging volumes with i2p disabled when Catalog all available snapshots is set to Yes and Traversal Method is set to Snapdiff.
Connection timeout (secs)
To run a catalog job, the application needs to connect with the resource. If there is no response within a certain time limit, it times out and the job session fails. Enter the number of seconds to wait before timing out.
Number of catalog instances to keep
After a certain number of job runs for a given job, older low-level NetApp ONTAP objects for that job are purged from the Inventory. Enter the number of job runs for which low-level NetApp ONTAP objects are to be retained. Note that by default, the old data for the job is purged from the ECX Inventory after the newer data is cataloged.
Condense catalog before run
Select this option to purge older low-level NetApp ONTAP objects from the ECX Inventory before newer data is cataloged through a NetApp ONTAP File Inventory job.
Condense catalog after failed run
Select this option to purge NetApp ONTAP objects from the ECX Inventory for the unsuccessful run of the NetApp ONTAP File Inventory job.
Traversal Method
This option indicates the methodology to employ when cataloging snapshots. ECX honors your preference if it is supported for the particular system configuration. If the selected preference is not supported for your system configuration, the operation fails.

SnapDiff. ECX performs cataloging based on snapshot differences. If SnapDiff is selected, the default number of files requested in each query is 256 and the default maximum number of volumes that are simultaneously cataloged is 8.

Filewalk. ECX retrieves owner information for files and folders for volumes that have CIFS shares. This option is used in conjunction with the ECX Filewalker tool. Once cataloging completes, searchable owner information is added to the Inventory. See the Filewalker documentation for more information.
Base snapshot for catalog
For file cataloging, a base snapshot on the storage system is required.
Create a new snapshot before cataloging. A new snapshot is created when the job session begins and is deleted after cataloging. This is the preferred method if sufficient resources are available.
Use latest snapshot. A new snapshot is not created; instead the latest healthy snapshot available for that volume is used to assist with file level cataloging. You can exclude certain snapshots from the set of snapshots ECX selects from by entering character patterns for those snapshots. Use a comma to separate each pattern.
Note: To catalog a volume that does not support snapshot creation, such as a SnapMirror volume, select Use latest snapshot.
Catalog all available snapshots
Yes. Catalogs snapshots on the volume in addition to the base snapshot. ECX examines additional snapshots ensuring the Inventory has the latest data. You can exclude certain snapshots from the set of snapshots ECX catalogs by entering character patterns for those snapshots. Use a comma to separate each pattern.
No. Catalogs only the base snapshot.
Note: By cataloging all available snapshots, you can view multiple versions of your files through a file-level search. Additional versions are available on the file's properties pane.
Optionally, expand the Notification section to select the job notification options.

SMTP Server
From the list of available SMTP resources, select the SMTP Server to use for job status email notifications. If an SMTP server is not selected, an email is not sent.
Email Address
Enter the email addresses of the status email notifications recipients. Click Add to add it to the list.

Optionally, expand the Schedule section to select the job scheduling options. Select Start job now to create a job definition that starts the job immediately. Select Schedule job to start at later time to view the list of available schedules. Optionally select one or more schedules for the job. As each schedule is selected, the schedule's name and description displays.
Note: To create and select a new schedule, click the Configure tab, then select Schedules . Create a schedule, return to the job editor, refresh the Available Schedules pane, and select the new schedule.
When you are satisfied that the job-specific information is correct, click Create Job. The job runs as defined by your schedule, or can be run manually from the Jobs tab.

Note: If you selected the Start job now option, the job runs.

NEXT STEPS:

If you do not want to wait until the next scheduled job run, run the job session on demand. See Start, Pause, and Hold a Job Session.
Track the progress of the job session on the Jobs tab. See Monitor a Job Session.
If notification options are enabled, an email message with information about the status of each task is sent when the job completes.