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 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 Aliases

The Aliases entered on the Networker Client Properties

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

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.

Total Max Writestreams

The total maximum write streams.

Total Max Streams

The Total Maximum streams.

Field

Value

Hostname

Networker Client

Saveset

The Backup/saveset name

Volume

The volume Name to which the saveset is written

Device Name

The Device Name on which the volume is mounted.

Mtree Name

The Mtree/Storage Unit on the Datadomain to which the Backup is written.

DD Name

The Datadomain on which the above Mtree and Device exist.

Base Job ID

A backup Unique ID

Time Started GMT

Creation Time of the backup

Capacity GB

The input Backup size before any deduplication or compression

For VMware, that is the VM used Bytes

Pre Dedupe GB

Changed Bytes on the Client before sent on the Network.

After Global Comp

Size of the Backup after Deduplication and just before Local Compression on the Datadomain

After Local Comp GB

Final size of the backup as written on the DD after Local Compression

Dedup Ratio Per Saveset

All Data

Field

Value

Workload Type

The type of the Networker policy assigned for the backup.

Front End Capacity (GB)

The Front End incoming capacity for each workload type.

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.

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 NW 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

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

Server

The name of the Networker Client

Backup ID

The Long SSID of the reported taken backup.

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.