Networker API Excel Definitions

Field

Value

Project ID

An Integer specifying the Project ID

Project Name

The Project Name

Date

The Date the Project was created in MM/DD/YYYY HH:MM:SS Time format

Owner

The name of the project Owner, Email of the Project Owner.

Collector Build Version

The build version of the collector that generated the first Collector Run in this project.

Data Points Definitions KB Article Link

The link of this KB Article is mentioned on the project for the users.

Disclaimer

 Disclaimer stating that All measurements on the report are Base 10 calculations and using the main non-SI unit for computer data storage "Byte" 

Field

Value

Networker Version

The version of the Networker software.

Up Since

The NW server services last day reboot.

Field

Value

Server

This is the Networker Server Name

Name

The name of the Volume

Pool

The name of the Pool on which that volume exists.

Type

The Type of the Media either Data Domain or Tapes or Tape Library.

Written(GB)

The written/used capacity on the volume in GB.

%Full

The percentage of the volume utilization

State

The state of the volume

Last Job

The last date and Time the volume was accessed.

Expiration

This Attribute specifies the savesets expiration Time on the volume.

Last Written (GB)

Last Written Capacity on the Volume in GB.

Unique ID

Volume ID

Pool Type

The Type of the Pool.

JukeBox

The Device Parent Juke Box. Mapping the volume to the device on which the volume is mounted.

Location

This attribute specifies the administrator-defined description of a physical location of the volume. Example The FQDN or the IP of the Data domain on which the volume is created

Serial Number

Device Serial Number. Mapping the volume to the device on which it is mounted.

Field

Value

Backup ID

A string specifying the value of the ID attribute in the backup resource. This ID can be used to retrieve information about that backup job. This is the long SSID by which the saveset is saveset on the target DD.

Backup Name

The exact path/target backed up on the client. The saveset backed up.

Backup Created

The date and time at which the saveset is taken. MM/DD/YYYY HH:MM:SS

Backup Completed

The date and time at which the saveset run completed.

Backup Time

The Duration of the Backup in HH:MM:SS

Backup Status

Gives the status of the backup as Recyclable, Browsable, Recoverable,..etc.

Clone Status

If a clone is taken gives the status of the Clone copy similar to the Backup Status values.

Backup Size

The Front End size of the save set taken in GB. Similar as Sumsize.

For VMware Backups,  the Backup size is taken as the used capacity by the VM and not the provisioned capacity.

Backup Type

The type of the backup taken as

“CoverSet","DSA","File","NDMP","Raw", or"Snapshot.

Number of Files

The number of Files included in the backup.

Backup Level

The level of the backup either Full, incremental, virtual synthetic,..etc.

Retention Time

The expiration date and time for the backup in terms of MM/DD/YYYY HH:MM:SS

Client Name

The name of the Networker Client backed up.

Client ID

 A unique ID specified for each Networker Client.

Client Save Time

Same as Backup Created data point.

VM Name

The name of the VM in case it is VMware backup.

vCenter Hostname

The FQDN or IP of the vCenter in case it is VMware backup.

Datastore MOID

The ID of the datastore on which the VM files exist in case it is VMware backup./ extracted from the Mob

Host MOID

The ID of the ESXi host of the VM being backed up in case it is VMware backup. / extracted from the Mob

VM MOID

The ID of the VM being backed up./ extracted from the Mob

MoRef Path

The full path of the VM starting from the datacenter of the VM till the VM name/ extracted from the Mob

Datastore Name

The name of the datastore of the VM being backed up.

Disk Name

The name of the hard disk backed up for the VM.

Protection Group

The name of the Networker Policy performing the backup.

Thin Provisoned

The provisioning type configured on the VM disks.

Field

Value

Client Name

The name of the Networker Client

Protection Group

The name of the Networker Policy performing the backup.

Backup Name

The exact path/folder/file backed up on the Networker Client. Saveset Name

Disk Name

The name of the hard disk backed up on the VM in case It is VMware backup.

Front End Capacity (GB)

The maximum captured Front End incoming capacity from the Networker Client for that specific Saveset

For VMware backups, Front End capacity is calculated as the maximum captured used capacity for each VM.

For Oracle Backups, Front End Capacity is calculated as the maximum full backup taken from the Oracle DB.

Max Files

The maximum number of files backed up from the Networker Client for that saveset.

Field

Value

Client ID

This attribute specifies the client's identifier and cannot be changed.

Client Aliases

This attribute specifies aliases for the client machine that queries can match. If this list is empty, match on client name alone.

Hostname

The name or IP of the Networker Client backed up.

Client OS

The Operating system of the Networker Client.

Client OS Type

The type of the Operating system of the Networker Client (Generic OS type).

Networker Version

The version of the Networker Clients software.

Protection Groups

The Policy groups names assigned to the Networker Client.

Retention Policy

The retention policy assigned to each client.

VM Client

The name of the VM in case it is VMware backup.

NDMP Client

The name o the NDMP client in case it is NAS backup.

Enabler In Use

A Boolean Flag specifying of Enabler In Use option is enabled on the client

Archive Enabled

A Boolean Flag set to true if Archiving is enabled for that client.

Block Based Backed

A Boolean flag set to true if BBB option is enabled for that client.

Targe Disks

The target device/devices specified as Networker target Media for the client.

Backup Type

The type of the backup taken in terms of File System, vproxy,..etc.

Client Direct Enabled

A Boolean flag set to true in case Client Direct option is enabled on the client properties.

Data Domain Backup

A Boolean flag set to true if backup is targeted to a Data domain.

Data Domain Interface

Type of connection to Data domain as IP or Fiber channel.

Scheduled Backup

A Boolean Flag specifying if that client is scheduled for backups or not

Schedule

String specifying the schedule assigned to each client.

Savesets

The exact savesets chosen to be backed up from the client

Backup Command

The entered backup command on the client to backup the specified savsets. This command depends on the type of the saveset being backed up and the application protected.

App Info

Application Information specified on the client properties. This attribute contains client application specific information.For example: In case of Microsoft SQL VDI, the application information could be ["NSR_PS_DEBUG_LEVEL=0","NSR_CONSISTENCY_CHECKS=FALSE"]. Here the NSR_PS_DEBUG_LEVEL option specifies the verbosity level of the logs and "NSR_CONSISTENCY_CHECKS=FALSE" option disables the consistency check for all databases in the SQL VDI instance. <br><br>These options are application specific and are documented in the respective application user guides.

Executable Path

String.This attribute specifies the path to the NetWorker executables on this client.

Parallelism

integer<int32>

This attribute specifies the number of data streams that a client can use simultaneously during backup.

Storage Nodes

 array [string]

This attribute specifies an ordered list of storage nodes for the client to use when saving its data.

Directive

string

This attribute can be used to specify the directive for the client. The choices are defined by the set of directives available under /directives

Client_determines_level

boolean

This attribute assigns the backup level determination to the client application.

Statistics

This attribute contains three values: the size of the client's on-line file index in kilobytes, the number of kilobytes actually used, and the number of entries in the index

Checkpoint_granularity

This attribute specifies whether to restart the backup from the point of failure at the directory or file level. The defualt value is Directory. <br><br>Directory - After each directory is saved, the data is committed to the media and index database. If a directory contains a large number of entries, intermediate checkpoints are created. <br><br>File - Use this option only for save sets with a few large files. Committing every file to the index and the media database is time consuming. Performance degradation may occur for backups that contain many small files.

Parallel_save_streams_per_saveset

boolean

This attribute specifies whether to enable Parallel Save Streams(PSS). Enabling PSS results in significant performance improvements due to save set aggregation.

Priority

string

This attribute specifies the priority for the client. During a backup operation, the NetWorker server contacts the client with the lowest priority value first. The valid range is 1 to 1000. If you do not specify a priority here, then the backup order is random. The default value is 500.

File_Inactivity Threshold

integer

This attribute specifies the number of days a file has not been accessed before it is counted as inactive. A value of zero indicates that no inactivity statistics are collected for this client.

File Inactivity Alert Threshold

integer

This attribute specifies the percentage of space occupied by inactive files, exceeding which will generate a notification. A value of zero indicates that no alert will be sent for this client.

Index_Backup_Content

boolean

This attribute specifies index files and directories on the snapshot.

Disable_IPv6

boolean

This attribute specifies whether to disable IPv6 for the NDMP client.

Nas_device

boolean

This attribute specifies whether this client is a NAS device.

Physical_client_Parallelism

boolean

This attribute specifies whether to override the client parallelism and use the physical client's parallelism.

Autoselect_storage_node

boolean

This attribute specifies whether the client can override the attributes of the backup target disks, storage nodes, and recover storage nodes.

Field

Value

Hostname

Networker Client Hostname

Saveset

The backup/Saveset name

Volume

The Volume name to which the backup is written

Device Name

The Device on which the volume mounted and saveset written to

Mtree Name

The Mtree of the Data domain that has the specified Device Access Information

DD Name

The Data Domain to which the backup is submitted

Base Job ID

The Backup Unique ID

Time Started (GMT)

The Time the Backup is created in GMT

Capacity (GB)

Initial Full Front End size of the Backup before deduplication or compression. In GB

Pre Dedupe (GB)

The scanned capacity before deduplication and Compression. For All Workloads types, the value is extracted from the DD Dedup Statistics listed as a Key with the Backup Information. For VMware, To Avoid white spaces, The Prededup capacity is taken from the VM used capacity and not provisioned capacity.

After Global Compression (GB)

The capacity of the Backup After Deduplication. For All Workloads types, the value is extracted from the DD Dedup Statistics listed as a Key with the Backup Information.

After Local Compression (GB)

The capacity of the Backup After Full Reduction.

Dedup Ratio Per Saveset

 (All Data / Unique Data) Pre Dedup  / After Global Comp

Data Reduction Ratio per Saveset

 (Dedupe Ratio * Compression Ratio) 

Retention

The Retention specified for the Backup

Field

Value

Hostname

The Networker Clients Hostnames

Client Total Input Capacity GB

For each client, giving the full capacity inputted from these clients for all their configured savesets. FETB per client.

Success Rate

The percentage of Successful Jobs among all jobs running per client

Average Backup Time (sec)

Sum of All Backups Times of a client divided by the number of Backups to five the Average backup Duration per client

Highest Backup Retention

The maximum Retention Time among all jobs of each client.

Field

Value

Serial Number

The System Serial number of the Data Domains server attached as a Media Target.

Name

The name or the IP of the Data Domain server.

Model

The hardware Model of the Data Domain server.

DD OS

The software version of the Data Domain Server.

Available Capacity (GB)

The total capacity used and available on the DD server in GBs.

Used Capacity (GB)

The used capacity on the DD server in Gega-bytes.

Used Logical Capacity (GB)

The pre-comp data incoming to the Data domain server. (Before compression and deduplication) in Gega-bytes.

Total Capacity (GB)

"totalCapacity"

The total capacity used and available on the DD server in GBs.

File Copy Streams

"inuseFilecopyStreams"

The number of in use streams reported for File Copy

Read Streams

The number of in use read streams

Max Read Streams

The assigned maximum value assigned for DD read streams.

Read / Write Streams

The number of in use Read/write streams.

Replication Streams

The number of in use source Replication streams

Replication Destination streams

The number of in use Destination Replication streams

Max Replication Source Streams

The assigned maximum number of Source Replication streams.

Max write streams

The assigned maximum number of write streams.

TotalMaxWritestreams

The total maximum write streams.

Total Max Streams

The Total Maximum streams.

Field

Value

Workload Type

The type of the Application protected by Networker: NVE Server, Server Protection, NAS, SQL, Oracle, vProxy…etc.

Front End Capacity (GB)

The Front End incoming capacity for each workload type.

Number of Files

The number of Files incoming for each workload Type.

Field

Value

Front End Capacity Reported (TB)

The FETB capacity incoming from that Networker server in Terabytes.

Field

Value

Name

The name of the tasks currently running on the Networker server. The job is a generic label for performing any operations, such as savefs, save, archive, index, and recover operations.

Job ID

A unique ID given for each task.

Parent Job ID

The previous reference job to the current Job.

Job Host

The name of the Networker Entity running the Job.

Initiation Type

The start type as scheduled or ondemand

Job type

The type of the job running.

Size (GB)

The size of the job in case its backup or recovery.

Number of Files

The number of Files included in the job.

Start Time

The date and time on which the task started MM/DD/YYYY HH:MM:SS

End Time

The date and Time on which the task Ended

MM/DD/YYYY HH:MM:SS

Current State

The current status of the job running.

Exit Code

The Exit Code as per Completion Status. Exit Code 0 means Completed successfully.

Completion Status

Final status of each job.

Client Name

The client name running the job if it is backup/recovery.

Tenancy

Tenant Name if configured.

vProxy Hostname

The name of the vproxy included in the VMware backup or recovery.

vProxyMountVCenter Hostname

The name of the vcenter on which the vproxy is mounted.

Field

Value

#Clients

Number of Clients Protected

Oracle (GB)

The total Inputted capacity for Oracle Workload

Exchange(GB)

The total Inputted Capacity for Exchange

Hyper V (GB)

The total Inputted Capacity for HyperV

SQL_VDI (GB)

The total Inputted capacity for SQL VDI

NAS (GB)

The total Inputted Capacity for NAS

Unix_Filesystems (GB)

The total Inputted Capacity for Unix Filesystems

VMware_Filesystems (GB)

The total Inputted Capacity for VMware Backups

Windows Filesystems (GB)

The total Inputted Capacity for windows File Systems

Filesystem (Windows+Unix)(GB)

The total inputted capacity for all Filesystem backups. This column is added to integrate with Networker 19.1 and 19.2 that has no Networker OS value to report windows and Unix separately.

Other Applications (GB)

The total Inputted Capacity for all other workloads

60 Days System Full Precomp(GB)

Sum of all inputted data:Oracle + Exchange + Hyper_V + SQL_VDI + NAS+  Unix_Filsystems + VMware_Filesystems + Windows_Filesystems + Other_Applications)

Days_Measured

Always set to 60 and this is the duration of the LO collection on Networker.

Field

Value

Host ID

The ID of the server hosting the License.

License Type

The License Type.

License Name

The name of the License.

Enabler Code

The source of the License.

Expiration Date

The expiry date for the License.

Field

Value

Protection Group

The name of the Networker Policy

<30 Days

Protection Policy with retention set to less than 30 days

<60 Days

Protection Policy with retention less than 2 months

<180 Days

Protection Policy with retention less than 180 days.

<365 Days

Protection Policy with retention less than a year.

< 7 Years

Protection Policy with retention less than 7 Years.

>= 7 Years

Protection Policy with retention more than 7 Years.

Field

Value

Client Hostname

The Networker Client Hostname

Backup Type

Workload Type

Client Total Capacity (GB)

For each client, for each protected workload Type for that client, this is the total of summing the Backups sizes of that client for that workload.

Note for VMware: Backup Size is the sum of the disks used spaces and not the provisioned disk space.

Field

Value

Client

The name of the Networker Client

Backup Name

The Saveset Backed up.

Protection Group

The Networker Policy running the job.

Duration

The time taken on the backup till complete.

Capacity (GB)

The size of the backup taken in GegaBytes.

Throughput (MB/sec)

The performance of the backup taken, Number of Megabytes per seconds.

Field

Value

Client

Networker Client Name

Clone Name

The name of the saveset Cloned

Start Time

The start time of the Clone Job

End Time

The End Time of the Clone Job

Clone Duration

The total duration of the Clone Job

Capacity (GB)

The size of the backup instance Cloned

Protection Group

The Policy Group that ran that clone Job

Throughput MB/sec

The Network transfer rate for that Clone Job

Field

Value

Device Name

This attribute specifies the name of the device. The device name is usually the pathname of a tape or a file type device, such as /dev/nrmt8. The name may be prefixed with 'rd=', the device's hostname and a colon. For an adv_file or Data Domain device, the name can be any string. For an adv_file or Data Domain device, use the "device access information" attribute to specify a path.</p> <br>. Note: You cannot change the name after the device is created. If needed, delete the device and create a new device.

NDMP

boolean

This attribute identifies the device as an NDMP device.

Volume

string

This attribute specifies the name of the volume mounted on this device

Media Family

string

The general class of storage media is determined automatically from the type of the device.

Media Type

The media type describes the actual storage media from the predefined list. This is a mandatory attribute.

Shared Devices

This attribute enables or disables all devices with the same hardware id.

Write Enabled

boolean

This attribute specifies whether the device is enabled for write.

Read Only

boolean

This attribute specifies whether the device is available for read-only operations.

Target # Sessions

This attribute specifies the number of save sessions dispatched to this device before another device is considered.

Max # Sessions

This attribute specifies the maximum number of save sessions for the device.

Access Weight

This attribute specifies the load distribution among drives in a jukebox. Changes to this attribute are propagated to all devices that have the same 'hardware ID' value.

Consec. Errors

This attribute specifies the number of consecutive errors on the device. This is a read-only attribute.

Max Consec. Errors

This attribute specifies the maximum number of consecutive errors allowed before the device is automatically disabled.

Jukebox Device

This attribute specifies if the media device is part of a jukebox device.

Jukebox

This attribute contains the name of the jukebox to which this device belongs.

Required Cleaning

This attribute indicates whether the media device needs to be cleaned.

Last Clean Date

This attribute specifies the last date when the media device was cleaned.

Hardware ID

This attribute specifies the last date when the media device was cleaned.

Tape Alert Critical

This attribute specifies critical diagnostic information, such as for media or drive failure, when user intervention is urgent and data is at risk.

Auto Detect ID

This attribute specifies the internal identifier for auto-detected device. This is a read-only attribute.

Accesses

This attribute specifies the number of operations performed on the device. This is a read-only attribute.

Device Serial #

This attribute specifies the serial number of the device.

Device Access Information

This attribute specifies the access path for an advance file or a Data Domain device.

Suspected_Device

This attribute specifies whether the device lost connection on storage node.

Suspect Mark Time

This attribute specifies the time stamp when the device lost connection on storage node. This is a read-only attribute.

Max_nsrmmd_count

This attribute specifies the maximum number of nsrmmd processes started for this device.

Current_nsrmmd_count

This attribute keeps track of the current number of nsrmmd processes currently started for the device. Only used for AFTD and Data Domain devices. This is a read-only attribute.

Volume Label

This attribute specifies the name of a volume to be labeled. This is a read-only attribute.

Volume Current Capacity

This attribute specifies the capacity of the volume that is currently being labeled. The units can be MegaBytes or GigaBytes, for example, '150 MB' or '5 GB'. This is a read-only attribute.

Volume Error Number

This attribute specifies the last error number reported for the device. This is a read-only attribute.

Volume Expiration

This attribute specifies the expiration date of the volume in the format E MMM dd HH:mm:ss yyyy (Thu Jun 02 17:23:09 2022) that is currently being labeled, or the result of a 'Verify Label' operation. The default value, 2 years, is reset each time the volume is relabeled.

Volume Pool

This attribute specifies the pool to which the current volume belongs.

Volume ID

This attribute specifies the volume ID for the currently mounted volume.

Long Vol ID

This attribute specifies the volume id in the long format for the currently mounted volume. This is a read-only attribute.

DD_retention_lock_mode

This attribute enables or disables the Data Domain retention lock. Note: This attribute is supported only for a Data Domain device.

Idle Device Timeout

This attribute specifies the number of minutes before an idle device is unmounted. This attribute only applies to jukebox devices.

Save Mount Timeout

This attribute specifies the timeout value of an initial save mount request for the storage node on which the device resides.

Save Lockout

This attribute specifies the number of minutes a storage node will be locked from receiving save assignments, after it times out from a save mount request.

Warn_On_suspect_volumes_perc

This attribute specifies the minimum threshold (percentage value) of advertised tape capacity at which the user will be warned when a tape is prematurely marked full.

Field

Value

Name

The name of the Directive

Directive

The actual configuration of the Directive.

Field

Value

Pool Name

This attribute specifies the name of the pool.

Enabled

This attribute specifies whether this pool can be selected.

Pool Type

This attribute determines how volumes that are members of this pool will be used.

Archive Only

boolean

This attribute determines whether the volumes are used for archive only. The attribute `poolType' supersedes this attribute. This is a read-only attribute

Label Template

This attribute specifies the template to use for labeling the volumes in this pool.

Groups

Protection groups assigned to the clients writing backup on that Pool.

Clients

Client Names configured to write on that Pool

Savesets

Savesets configured to run on that pool

Devices

Devices configured on that Pool

Max Parallelism

This attribute specifies the maximum parallel sessions per device allowed for backups to this pool.

Media_type_required

This attribute specifies that only media of this type can be labeled into this pool. This attribute cannot be set if the media type preference attribute is set. This attribute cannot be used to specify the capacity of the media

Recycle_start

This attribute specifies the time to start recyling (HH:MM).

Recycle_Interval

This attribute specifies the frequency of recycling runs. The default value is 24:00, which means that recycling runs once a day.

Recycle_start_now

boolean

This attribute is specified as true if the volumes that are associated with this pool are to be recycled immediately. It is an update-only attribute

Max_volumes_to_recycle

This attribute specifies the maximum number of volumes to be recycled.

Field

Value

Name

This attribute specifies the schedule’s name. The schedule is referred to by its name in client resources.

Levels

This attribute specifies the sequence of save levels making up the schedule. One entry is used for each day of the schedule. The valid levels are "full", "incr", "incr_synth_full", "skip", "txnlog", and the number "1".

Activity Type

Type of the Activity on that schedule

Period

This attribute specifies the length of the schedule’s period. It may be either "Week" or "Month". "Week" schedules repeat every 7 days and start on Sunday. "Month" schedules start over at the first of each month. The default is "Week".

Sequence

This attribute specifies the sequencing.

Override

This gives the level and pattern of the schedule is the overrides variable is set to override specific levels on the schedule configured.

Field

Value

Name

This attribute specifies the name of the storage node.

Is Configured

boolean

This attribute specifies whether a device has already been configured on this storage node.

Registration Date

This attribute specifies the date and time when the storage node is registered/created, the date and time when the first device is created on this storage node, or the date and time when the last device configured on it is removed.

Device Sharing Mode

This attribute specifies the device sharing setting at the storage node level.

Clients

All client names configured to utilize this storage node for backup.

Max Active Devices

This attribute specifies the maximum number of devices that NetWorker may use from this storage node.

Clone Nodes

This attribute specifies the hostname of the storage nodes to which clone data is written, if the destination storage node for a clone action is not specified in the protection policy.

Dedicated Storage Node

boolean

This attribute indicates whether this is a dedicated storage node.

Daemon_versions

This attribute specifies the storage node daemon versions. Storage node daemons are responsible for NetWorker save and recover media multiplexing operations.

Enabled

boolean

This attribute specifies whether the storage node is available for use.

Ready

boolean

This attribute specifies whether the storage node is ready to accept device operations.

Dynamic_nsrmmds

boolean

This attribute specifies whether nsrmmd processes on this storage node device are started dynamically.

#Devs

This attribute specifies the count of the devices defined on this storage node.

#Libs

This attribute specifies the count of the libraries defined on this storage node.

Config Devs

This attribute specifies the count of the libraries defined on this storage node.

Config Libs

This attribute specifies the count of the libraries defined on this storage node.

Config Silos

This attribute specifies the silos currently defined for this storage node.