Contents

Dell NetWorker 19.1 Software REST API Reference Guide PDF

1 of 387
1 of 387

Summary of Content for Dell NetWorker 19.1 Software REST API Reference Guide PDF

Dell EMC NetWorker Version 19.1.x

REST API Reference Guide 302-005-705

Rev 02

August, 2019

Copyright 1990-2019 Dell Inc. or its subsidiaries All rights reserved.

Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS-IS. DELL MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND

WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF

MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. USE, COPYING, AND DISTRIBUTION OF ANY DELL SOFTWARE DESCRIBED

IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE.

Dell Technologies, Dell, EMC, Dell EMC and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property

of their respective owners. Published in the USA.

Dell EMC Hopkinton, Massachusetts 01748-9103 1-508-435-1000 In North America 1-866-464-7381 www.DellEMC.com

2 Dell EMC NetWorker REST API Reference Guide

Preface

As part of an effort to improve its product lines, Dell EMC periodically releases revisions of its software and hardware. Therefore, some functions that are described in this document might not be supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information on product features.

Contact your Dell EMC technical support professional if a product does not function correctly or does not function as described in this document.

Note: This document was accurate at publication time. Go to Dell EMC Online Support (https://support.emc.com) to ensure that you are using the latest version of this document.

Purpose

This document describes how to configure and use NetWorker REST API.

Audience

This guide is part of the NetWorker documentation set, and is intended for use by developers who are creating programmatic interfaces to NetWorker systems.

Revision history

The following table presents the revision history of this document.

Table 1 Revision history

Revision Date Description

02 August 14, 2019 Updated for NetWorker 19.1.1 release.

01 May 20, 2019 First release of the document for NetWorker 19.1.

Related documentation

The NetWorker documentation set includes the following publications, available on the Support website:

l NetWorker E-LAB Navigator Provides compatibility information, including specific software and hardware configurations that NetWorker supports. To access E-LAB Navigator, go to https://elabnavigator.emc.com/eln/elnhome.

l NetWorker Administration Guide Describes how to configure and maintain the NetWorker software.

l NetWorker Network Data Management Protocol (NDMP) User Guide Describes how to use the NetWorker software to provide data protection for NDMP filers.

l NetWorker Cluster Integration Guide Contains information related to configuring NetWorker software on cluster servers and clients.

l NetWorker Installation Guide

Dell EMC NetWorker REST API Reference Guide 3

Provides information on how to install, uninstall, and update the NetWorker software for clients, storage nodes, and servers on all supported operating systems.

l NetWorker Updating from a Previous Release Guide Describes how to update the NetWorker software from a previously installed release.

l NetWorker Release Notes Contains information on new features and changes, fixed problems, known limitations, environment and system requirements for the latest NetWorker software release.

l NetWorker Command Reference Guide Provides reference information for NetWorker commands and options.

l NetWorker Data Domain Boost Integration Guide Provides planning and configuration information on the use of Data Domain devices for data deduplication backup and storage in a NetWorker environment.

l NetWorker Performance Optimization Planning Guide Contains basic performance tuning information for NetWorker.

l NetWorker Server Disaster Recovery and Availability Best Practices Guide Describes how to design, plan for, and perform a step-by-step NetWorker disaster recovery.

l NetWorker Snapshot Management Integration Guide Describes the ability to catalog and manage snapshot copies of production data that are created by using mirror technologies on storage arrays.

l NetWorkerSnapshot Management for NAS Devices Integration Guide Describes how to catalog and manage snapshot copies of production data that are created by using replication technologies on NAS devices.

l NetWorker Security Configuration Guide Provides an overview of security configuration settings available in NetWorker, secure deployment, and physical security controls needed to ensure the secure operation of the product.

l NetWorker VMware Integration Guide Provides planning and configuration information on the use of VMware in a NetWorker environment.

l NetWorker Error Message Guide Provides information on common NetWorker error messages.

l NetWorker Licensing Guide Provides information about licensing NetWorker products and features.

l NetWorker REST API Getting Started Guide Describes how to configure and use the NetWorker REST API to create programmatic interfaces to the NetWorker server.

l NetWorker REST API Reference Guide Provides the NetWorker REST API specification used to create programmatic interfaces to the NetWorker server.

l NetWorker 18.2 with CloudBoost 18.2 Integration Guide Describes the integration of NetWorker with CloudBoost.

l NetWorker 18.2 with CloudBoost 18.2 Security Configuration Guide Provides an overview of security configuration settings available in NetWorker and Cloud Boost, secure deployment, and physical security controls needed to ensure the secure operation of the product.

Preface

4 Dell EMC NetWorker REST API Reference Guide

l NetWorker Management Console Online Help Describes the day-to-day administration tasks performed in the NetWorker Management Console and the NetWorker Administration window. To view the online help, click Help in the main menu.

l NetWorker User Online Help Describes how to use the NetWorker User program, which is the Windows client interface, to connect to a NetWorker server to back up, recover, archive, and retrieve files over a network.

Special notice conventions that are used in this document

The following conventions are used for special notices:

NOTICE Identifies content that warns of potential business or data loss.

Note: Contains information that is incidental, but not essential, to the topic.

Typographical conventions

The following type style conventions are used in this document:

Table 2 Style conventions

Bold Used for interface elements that a user specifically selects or clicks, for example, names of buttons, fields, tab names, and menu paths. Also used for the name of a dialog box, page, pane, screen area with title, table label, and window.

Italic Used for full titles of publications that are referenced in text.

Monospace Used for:

l System code

l System output, such as an error message or script

l Pathnames, file names, file name extensions, prompts, and syntax

l Commands and options

Monospace italic Used for variables.

Monospace bold Used for user input.

[ ] Square brackets enclose optional values.

| Vertical line indicates alternate selections. The vertical line means or for the alternate selections.

{ } Braces enclose content that the user must specify, such as x, y, or z.

... Ellipses indicate non-essential information that is omitted from the example.

You can use the following resources to find more information about this product, obtain support, and provide feedback.

Where to find product documentation

l https://www.dell.com/support

l https://community.emc.com

Preface

Dell EMC NetWorker REST API Reference Guide 5

Where to get support

The Support website https://www.dell.com/support provides access to product licensing, documentation, advisories, downloads, and how-to and troubleshooting information. The information can enable you to resolve a product issue before you contact Support.

To access a product-specific page:

1. Go to https://www.dell.com/support.

2. In the search box, type a product name, and then from the list that appears, select the product.

Knowledgebase

The Knowledgebase contains applicable solutions that you can search for either by solution number (for example, KB000xxxxxx) or by keyword.

To search the Knowledgebase:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Knowledge Base.

3. In the search box, type either the solution number or keywords. Optionally, you can limit the search to specific products by typing a product name in the search box, and then selecting the product from the list that appears.

Live chat

To participate in a live interactive chat with a support agent:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Contact Support.

3. On the Contact Information page, click the relevant support, and then proceed.

Service requests

To obtain in-depth help from Licensing, submit a service request. To submit a service request:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Service Requests.

Note: To create a service request, you must have a valid support agreement. For details about either an account or obtaining a valid support agreement, contact a sales representative. To get the details of a service request, in the Service Request Number field, type the service request number, and then click the right arrow.

To review an open service request:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Service Requests.

3. On the Service Requests page, under Manage Your Service Requests, click View All Dell Service Requests.

Online communities

For peer contacts, conversations, and content on product support and solutions, go to the Community Network https://community.emc.com. Interactively engage with customers, partners, and certified professionals online.

Preface

6 Dell EMC NetWorker REST API Reference Guide

How to provide feedback

Feedback helps to improve the accuracy, organization, and overall quality of publications. You can send feedback to DPAD.Doc.Feedback@emc.com.

Preface

Dell EMC NetWorker REST API Reference Guide 7

Preface

8 Dell EMC NetWorker REST API Reference Guide

NetWorker 9.1.x REST API Reference Guide. 9

Dell Customer Communication - Confidential

NetWorker REST API RESOURCE REFERENCE

The NetWorker REST API is available in the following base URI: https://{nw-server-hostname}:9090/nwrestapi/v3 There is one URI group: {baseuri}/global To access client resources, you must use the URI group, followed by the associated tag. For example, https://{nw-server-hostname}:9090/nwrestapi/v3/global/{id} The {id} corresponds to the Resource tag of the client.

Version: 19.1.0 BasePath:/nwrestapi/v3/global Copyright 1990-2019 Dell Inc. or its subsidiaries. All rights reserved. https://www.dellemc.com

Access

1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Alerts

GET /alerts

Backups

DELETE /backups/{backupId} DELETE /backups/{backupId}/instances/{instanceId} GET /backups/{backupId} GET /backups/{backupId}/instances/{instanceId} GET /backups/{backupId}/instances GET /backups

Clients

POST /clients/{clientId}/op/backup DELETE /clients/{clientId} GET /clients/{clientId}

NetWorker 9.1.x REST API Reference Guide. 10

Dell Customer Communication - Confidential

GET /clients/{clientId}/backups/{backupId} GET /clients/{clientId}/backups/{backupId}/instances/{instanceId} GET /clients/{clientId}/backups/{backupId}/instances GET /clients/{clientId}/backups GET /clients/{clientId}/indexes GET /clients POST /clients PUT /clients/{clientId}

Cloudboostappliances

GET /cloudboostappliances/{cloudboostapplianceId} GET /cloudboostappliances

Datadomainsystems

GET /datadomainsystems

Devices

DELETE /devices/{deviceId} GET /devices/{deviceId} GET /devices/{deviceId}/opstatus GET /devices POST /devices/{deviceId}/op/label POST /devices/{deviceId}/op/mount POST /devices/{deviceId}/op/unmount POST /devices/{deviceId}/op/verifylabel POST /devices PUT /devices/{deviceId}

Directives

DELETE /directives/{directiveId} GET /directives/{directiveId} GET /directives POST /directives PUT /directives/{directiveId}

Jobs

GET /jobs/{jobId} GET /jobgroups/{jobGroupId} GET /jobgroups GET /jobindications GET /jobs/{jobId}/log GET /jobs POST /jobs/{jobId}/op/cancel

NetWorker 9.1.x REST API Reference Guide. 11

Dell Customer Communication - Confidential

Labels

DELETE /labels/{labelId} GET /labels/{labelId} GET /labels POST /labels PUT /labels/{labelId}

Licenses

GET /licenses/{licenseId} GET /licenses

Nasdevices

DELETE /nasdevices/{nasdeviceId} GET /nasdevices/{nasdeviceId} GET /nasdevices POST /nasdevices PUT /nasdevices/{nasdeviceId}

Notifications

DELETE /notifications/{notificationId} GET /notifications/{notificationId} GET /notifications POST /notifications PUT /notifications/{notificationId}

Pools

DELETE /pools/{poolId} GET /pools/{poolId} GET /pools POST /pools PUT /pools/{poolId}

Probes

DELETE /probes/{probeId} GET /probes/{probeId} GET /probes POST /probes PUT /probes/{probeId}

Protectiongroups

DELETE /protectiongroups/{protectionGroupId}

NetWorker 9.1.x REST API Reference Guide. 12

Dell Customer Communication - Confidential

GET /protectiongroups/{protectionGroupId} GET /protectiongroups POST /protectiongroups PUT /protectiongroups/{protectionGroupId} POST

/protectiongroups/{protectionGroupId}/op/updatevmwareworkitems

Protectionpolicies

DELETE /protectionpolicies/{policyId} DELETE /protectionpolicies/{policyId}/workflows/{workflowId} GET /protectionpolicies GET /protectionpolicies/{policyId} GET /protectionpolicies/{policyId}/jobgroups/{jobGroupId} GET /protectionpolicies/{policyId}/jobgroups GET /protectionpolicies/{policyId}/workflows/{workflowId} GET

/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups/{j

obGroupId} GET

/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups POST /protectionpolicies POST /protectionpolicies/{policyId}/workflows POST

/protectionpolicies/{policyId}/workflows/{workflowId}/op/backup PUT /protectionpolicies/{policyId} PUT /protectionpolicies/{policyId}/workflows/{workflowId}

Recovers

DELETE /recovers/{recoverId} GET /recovers/{recoverId} GET /recovers POST /recovers

Rotectionpolicies

GET /protectionpolicies/{policyId}/workflows

Rules

DELETE /rules/{ruleName} GET /rules/{ruleName} GET /rules POST /rules PUT /rules/{ruleName}

Schedules

NetWorker 9.1.x REST API Reference Guide. 13

Dell Customer Communication - Confidential

DELETE /schedules/{scheduleName} GET /schedules/{scheduleName}/associatedpolicies GET /schedules/{scheduleName} GET /schedules POST /schedules PUT /schedules/{scheduleName}

Server

DELETE /usergroups/{userGroupId} GET /auditlogconfig GET /serverconfig GET /servermessages GET /serverstatistics GET /usergroups/{userGroupId} GET /usergroups POST /usergroups PUT /auditlogconfig PUT /serverconfig PUT /usergroups/{userGroupId}

Sessions

GET /sessions/{sessionId} GET /sessions POST /sessions/{sessionId}/op/cancel

Storagenodes

DELETE /storagenodes/{storageNodeId} GET /storagenodes/{storageNodeId} GET /storagenodes POST /storagenodes PUT /storagenodes/{storageNodeId}

Tenants

DELETE /tenants/{tenantId} GET /tenants/{tenantId} GET /tenants POST /tenants PUT /tenants/{tenantId}

Vmware

DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id}

NetWorker 9.1.x REST API Reference Guide. 14

Dell Customer Communication - Confidential

DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-

session-id} DELETE /vmware/vcenters/{vcenter-hostname} DELETE /vmware/vproxies/{vproxy-hostname} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id}/contents GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-id} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-

session-id}/contents GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-

session-id} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id} GET /vmware/vcenters/{vcenter-hostname} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-uuid} GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups GET /vmware/vcenters/{vcenter-hostname}/protectedvms GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid} GET /vmware/vcenters/{vcenter-hostname}/vms GET /vmware/vcenters GET /vmware/protectedvms GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-

uuid}/protectiondetails GET /vmware/vms GET /vmware/vproxies GET /vmware/vproxies/{vproxy-hostname} POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse

NetWorker 9.1.x REST API Reference Guide. 15

Dell Customer Communication - Confidential

POST /vmware/vproxies/op/register POST /vmware/vcenters POST /vmware/vcenters/{vcenter-hostname}/op/refresh POST /vmware/vcenters/{vcenter-hostname}/plugins POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/inspectbackup POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/inspectbackup POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/recover POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/recover POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount POST /vmware/op/refreshvcenters POST /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}/op/backup POST /vmware/vproxies PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id} PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-

id}/op/vmmount/{vproxy-mount-session-id}/vmbrowse/{vproxy-browse-

session-id} PUT /vmware/vcenters/{vcenter-hostname} PUT /vmware/vproxies/{vproxy-hostname}

Volumes

DELETE /volumes/{volumeId} GET /volumes/{volumeId} GET /volumes

Alerts

Up GET /alerts

Returns the most recent alert messages. (getAlerts)

This operation can be used to list the outstanding alert messages. The query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the

NetWorker 9.1.x REST API Reference Guide. 16

Dell Customer Communication - Confidential

results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

AlertList

Example data

Content-Type: application/json

{

"alerts" : [ {

"category" : "server",

"message" : "Process nsrworkflow crashed. New core file

found on server RHEL67_base. Check daemon.raw for details.",

"priority" : "critical",

"timestamp" : "2018-10-22T10:00:00-04:00"

} ],

"count" : 1

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the alerts are retrieved successfully. AlertList

400 BadRequestErrorResponse

401 AuthNErrorResponse

NetWorker 9.1.x REST API Reference Guide. 17

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Backups

Up DELETE /backups/{backupId}

Deletes the specified backup. (deleteBackup)

Deletes the specified backup.

Path parameters

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Backup is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up DELETE /backups/{backupId}/instances/{instanceId}

NetWorker 9.1.x REST API Reference Guide. 18

Dell Customer Communication - Confidential

Deletes the specific backup instance. (deleteBackupInstance)

Deletes the specific backup instance.

Path parameters

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

instanceId (required) Path Parameter is the value of the id attribute in the instance resource.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Backup instance is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /backups/{backupId}

Returns information about the specific backup. (getBackup)

This operation can fetch the information about the specific backup.

Path parameters

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

Return type

NetWorker 9.1.x REST API Reference Guide. 19

Dell Customer Communication - Confidential

Backup

Example data

Content-Type: application/json

{

"attributes" : [ {

"key" : "*backup start time",

"values" : [ "1539851225" ]

}, {

"key" : "*NSR_VSS_SHADOWCOPY_SET",

"values" : [ "{99F44A83-0BBF-49A8-B240-0970990DE6A8}" ]

}, {

"key" : "*policy action jobid",

"values" : [ "6" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1539851250" ]

}, {

"key" : "*policy name",

"values" : [ "TEST: 1539851250" ]

}, {

"key" : "*policy workflow name",

"values" : [ "TEST_WF: 1539851250" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1539851250: 1539851250:

2752349" ]

}, {

"key" : "group",

"values" : [ "TEST_PG" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-11-18T23:59:59-05:00",

"clientHostname" : "host_name_1",

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"completionTime" : "2018-10-18T04:27:30-04:00",

"creationTime" : "2018-10-18T04:27:30-04:00",

"fileCount" : 3,

"id" : "627a330c-00000006-ffc843f2-5bc843f2-00035000-360c1a56",

"instances" : [ {

"clone" : false,

"id" : "1539851250",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/backups/627a330c-00000006-ffc843f2-

5bc843f2-00035000-360c1a56/instances/1539851250",

"rel" : "item"

NetWorker 9.1.x REST API Reference Guide. 20

Dell Customer Communication - Confidential

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/volumes/13124488",

"title" : "Volume"

} ],

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"level" : "Full",

"name" : "E:\\file2.txt",

"retentionTime" : "2018-11-18T23:59:59-05:00",

"saveTime" : "2018-10-18T04:27:30-04:00",

"shortId" : "4291314674",

"size" : {

"unit" : "Byte",

"value" : 1680

},

"type" : "File"

}

Responses

200 Information about the backup is retrieved successfully. Backup

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /backups/{backupId}/instances/{instanceId}

Returns information on a specific backup instance. (getBackupInstance)

This operation can be used to retrieve the information about a specific backup instance.

Path parameters

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

instanceId (required) Path Parameter is the value of the id attribute in the instance resource.

Return type

BackupInstance

NetWorker 9.1.x REST API Reference Guide. 21

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"clone" : false,

"id" : "1539851250",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/volumes/13124488",

"title" : "Volume"

} ],

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Backup instance information is retrieved successfully. BackupInstance

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /backups/{backupId}/instances

Returns a list of backup instances. (getBackupInstances)

This operation can be used to retrieve a list of backup instances. However, the query parameters can be used to filter the response.

Path parameters

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

Query parameters

NetWorker 9.1.x REST API Reference Guide. 22

Dell Customer Communication - Confidential

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

BackupInstanceList

Example data

Content-Type: application/json

{

"backupInstances" : [ {

"clone" : false,

"id" : "1539851250",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/backups/627a330c-00000006-ffc843f2-

5bc843f2-00035000-360c1a56/instances/1539851250",

"rel" : "item"

} ],

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"count" : 1

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 23

Dell Customer Communication - Confidential

200 Information about the backup instances are retrieved successfully. BackupInstanceList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /backups

Returns information on all the backups. (getBackups)

This operation can be used to retrieve the information about all the backups. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

BackupList

Example data

Content-Type: application/json

{

"backups" : [ {

"attributes" : [ {

"key" : "*backup start time",

NetWorker 9.1.x REST API Reference Guide. 24

Dell Customer Communication - Confidential

"values" : [ "1539851225" ]

}, {

"key" : "*NSR_VSS_SHADOWCOPY_SET",

"values" : [ "{99F44A83-0BBF-49A8-B240-0970990DE6A8}" ]

}, {

"key" : "*policy action jobid",

"values" : [ "6" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1539851250" ]

}, {

"key" : "*policy name",

"values" : [ "TEST: 1539851250" ]

}, {

"key" : "*policy workflow name",

"values" : [ "TEST_WF: 1539851250" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1539851250: 1539851250:

2752349" ]

}, {

"key" : "group",

"values" : [ "TEST_PG" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-11-19T00:00:00-05:00",

"clientHostname" : "host_name_1",

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"completionTime" : "2018-10-18T04:27:31-04:00",

"creationTime" : "2018-10-18T04:27:30-04:00",

"fileCount" : 3,

"id" : "f30d0990-00000006-fec843f2-5bc843f2-00045000-360c1a56",

"instances" : [ {

"clone" : false,

"id" : "1539851250",

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"level" : "Full",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/backups/f30d0990-00000006-fec843f2-

5bc843f2-00045000-360c1a56",

"rel" : "item"

} ],

"name" : "E:\\file1.txt",

"retentionTime" : "2018-11-19T00:00:00-05:00",

"saveTime" : "2018-10-18T04:27:31-04:00",

NetWorker 9.1.x REST API Reference Guide. 25

Dell Customer Communication - Confidential

"shortId" : "4274537458",

"size" : {

"unit" : "Byte",

"value" : 1680

},

"type" : "File"

}, {

"attributes" : [ {

"key" : "*backup start time",

"values" : [ "1539851225" ]

}, {

"key" : "*NSR_VSS_SHADOWCOPY_SET",

"values" : [ "{99F44A83-0BBF-49A8-B240-0970990DE6A8}" ]

}, {

"key" : "*policy action jobid",

"values" : [ "6" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1539851250" ]

}, {

"key" : "*policy name",

"values" : [ "TEST: 1539851250" ]

}, {

"key" : "*policy workflow name",

"values" : [ "TEST_WF: 1539851250" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1539851250: 1539851250:

2752349" ]

}, {

"key" : "group",

"values" : [ "TEST_PG" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-11-18T23:59:59-05:00",

"clientHostname" : "host_name_1",

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"completionTime" : "2018-10-18T04:27:30-04:00",

"creationTime" : "2018-10-18T04:27:30-04:00",

"fileCount" : 3,

"id" : "627a330c-00000006-ffc843f2-5bc843f2-00035000-360c1a56",

"instances" : [ {

"clone" : false,

"id" : "1539851250",

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

NetWorker 9.1.x REST API Reference Guide. 26

Dell Customer Communication - Confidential

"level" : "Full",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/backups/627a330c-00000006-ffc843f2-

5bc843f2-00035000-360c1a56",

"rel" : "item"

} ],

"name" : "E:\\file2.txt",

"retentionTime" : "2018-11-18T23:59:59-05:00",

"saveTime" : "2018-10-18T04:27:30-04:00",

"shortId" : "4291314674",

"size" : {

"unit" : "Byte",

"value" : 1680

},

"type" : "File"

} ],

"count" : 2

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the backups are retrieved successfully. BackupList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Clients

Up POST /clients/{clientId}/op/backup

Backup the save sets for a given client. (clientOpBackup)

NetWorker 9.1.x REST API Reference Guide. 27

Dell Customer Communication - Confidential

This operation can be used to run an on-demand backup by specifying the workflow and the protection policy.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

clientOpBackup ClientOpBackup (required) Body Parameter Parameters to start the backup.

Example request body

Content-Type: application/json

{

"policy": "Platinum",

"workflow": "ServerWorkflow"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201

NetWorker 9.1.x REST API Reference Guide. 28

Dell Customer Communication - Confidential

A job is created. The Job URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up DELETE /clients/{clientId}

Deletes the specified client. (deleteClient)

This operation can be used to delete a specific client from NetWorker. A client represents host on a network, such as a computer, workstation, or application server whose data can be backed up and restored with the backup server software.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Client is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403

NetWorker 9.1.x REST API Reference Guide. 29

Dell Customer Communication - Confidential

AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /clients/{clientId}

Returns the specific client. (getClient)

This operation can fetch the information about the specific client. A client represents host on a network, such as a computer, workstation, or application server whose data can be backed up and restored with the backup server software.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

Query parameters

type (optional) Query Parameter The parameter "type" can be used to return additional client attributes based on the specified value from the predefined list. For example, to view advanced attributes, set the category type to "advanced", as in /clients?type=advanced. By default, if the parameter "type" is not specified, the type is "basic". default: basic

Return type

Client

Example data

Content-Type: application/json

{

"aliases" : [ "host_name_1", "localhost6" ],

"applicationInformation" : [ ],

"backupCommand" : "savepsm",

"blockBasedBackup" : false,

"checkpointEnabled" : false,

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"hostname" : "host_name_1",

"indexBackupContent" : false,

"links" : [ {

NetWorker 9.1.x REST API Reference Guide. 30

Dell Customer Communication - Confidential

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176/backups",

"title" : "List of backups"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176/op/backup",

"title" : "Back up client"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176/indexes",

"title" : "Indexes of backup"

} ],

"nasDevice" : false,

"ndmp" : false,

"ndmpMultiStreamsEnabled" : false,

"ndmpVendorInformation" : [ ],

"parallelSaveStreamsPerSaveSet" : false,

"parallelism" : 12,

"protectionGroups" : [ "NMC server" ],

"remoteAccessUsers" : [ ],

"resourceId" : {

"id" : "161.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 3

},

"saveSets" : [ "C:\\Program Files\\EMC

NetWorker\\Management\\nmcdb_stage" ],

"scheduledBackup" : true,

"storageNodes" : [ "nsrserverhost" ],

"tags" : [ ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Client information is retrieved successfully. Client

400 BadRequestErrorResponse

401 AuthNErrorResponse

404

NetWorker 9.1.x REST API Reference Guide. 31

Dell Customer Communication - Confidential

NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /clients/{clientId}/backups/{backupId}

Returns information on specific backup for the given client. (getClientBackup)

This operation can be used to retrieve the information on a specific backup for the given client.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

Return type

Backup

Example data

Content-Type: application/json

{

"attributes" : [ {

"key" : "*backup start time",

"values" : [ "1539851225" ]

}, {

"key" : "*NSR_VSS_SHADOWCOPY_SET",

"values" : [ "{99F44A83-0BBF-49A8-B240-0970990DE6A8}" ]

}, {

"key" : "*policy action jobid",

"values" : [ "6" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1539851250" ]

}, {

"key" : "*policy name",

"values" : [ "TEST: 1539851250" ]

}, {

"key" : "*policy workflow name",

"values" : [ "TEST_WF: 1539851250" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1539851250: 1539851250:

2752349" ]

NetWorker 9.1.x REST API Reference Guide. 32

Dell Customer Communication - Confidential

}, {

"key" : "group",

"values" : [ "TEST_PG" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-11-19T00:00:00-05:00",

"clientHostname" : "host_name_1",

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"completionTime" : "2018-10-18T04:27:31-04:00",

"creationTime" : "2018-10-18T04:27:30-04:00",

"fileCount" : 3,

"id" : "f30d0990-00000006-fec843f2-5bc843f2-00045000-360c1a56",

"instances" : [ {

"clone" : false,

"id" : "1539851250",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176/backups/f30d0990-00000006-fec843f2-5bc843f2-00045000-

360c1a56/instances/1539851250",

"rel" : "item"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/volumes/13124488",

"title" : "Volume"

} ],

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"level" : "Full",

"name" : "E:\\file1.txt",

"retentionTime" : "2018-11-19T00:00:00-05:00",

"saveTime" : "2018-10-18T04:27:31-04:00",

"shortId" : "4274537458",

"size" : {

"unit" : "Byte",

"value" : 1680

},

"type" : "File"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

NetWorker 9.1.x REST API Reference Guide. 33

Dell Customer Communication - Confidential

Responses

200 Information about the backup is retrieved successfully. Backup

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /clients/{clientId}/backups/{backupId}/instances/{instanceId}

Returns a specific backup instance for a given backup associated with a specific client. (getClientBackupInstance)

This operation can be used to retrieve the information about the specific backup instance which is associated with a specific client.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

backupId (required) Path Parameter is the value of the id attribute in the backup resource.

instanceId (required) Path Parameter is the value of the id attribute in the backup instance resource.

Return type

BackupInstance

Example data

Content-Type: application/json

{

"clone" : false,

"id" : "1539851250",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/volumes/13124488",

"title" : "Volume"

} ],

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

NetWorker 9.1.x REST API Reference Guide. 34

Dell Customer Communication - Confidential

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Backup instance information is retrieved successfully. BackupInstance

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /clients/{clientId}/backups/{backupId}/instances

Returns a list of backup instances for a given backup associated with a specific client. (getClientBackupInstances)

This operation can be used to retrieve the information about all the backup instances for a specific backup which are associated with a specific client. However, the query parameters can be used to filter the response.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

backupId (required) Path Parameter is the value of the id attribute in the backup instance resource.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with

NetWorker 9.1.x REST API Reference Guide. 35

Dell Customer Communication - Confidential

AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

BackupInstanceList

Example data

Content-Type: application/json

{

"backupInstances" : [ {

"clone" : false,

"id" : "1539851250",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176/backups/f30d0990-00000006-fec843f2-5bc843f2-00045000-

360c1a56/instances/1539851250",

"rel" : "item"

} ],

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"count" : 1

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the backup instances are retrieved successfully. BackupInstanceList

400

NetWorker 9.1.x REST API Reference Guide. 36

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /clients/{clientId}/backups

Returns a list of information on all the backups for a given client. (getClientBackups)

This operation can be used to retrieve the information about all the backups for a given client. However, the query parameters can be used to filter the response.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

BackupList

Example data

Content-Type: application/json

NetWorker 9.1.x REST API Reference Guide. 37

Dell Customer Communication - Confidential

{

"backups" : [ {

"attributes" : [ {

"key" : "*backup start time",

"values" : [ "1539851225" ]

}, {

"key" : "*NSR_VSS_SHADOWCOPY_SET",

"values" : [ "{99F44A83-0BBF-49A8-B240-0970990DE6A8}" ]

}, {

"key" : "*policy action jobid",

"values" : [ "6" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1539851250" ]

}, {

"key" : "*policy name",

"values" : [ "TEST: 1539851250" ]

}, {

"key" : "*policy workflow name",

"values" : [ "TEST_WF: 1539851250" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1539851250: 1539851250:

2752349" ]

}, {

"key" : "group",

"values" : [ "TEST_PG" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-11-19T00:00:00-05:00",

"clientHostname" : "host_name_1",

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"completionTime" : "2018-10-18T04:27:31-04:00",

"creationTime" : "2018-10-18T04:27:30-04:00",

"fileCount" : 3,

"id" : "f30d0990-00000006-fec843f2-5bc843f2-00045000-360c1a56",

"instances" : [ {

"clone" : false,

"id" : "1539851250",

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"level" : "Full",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

NetWorker 9.1.x REST API Reference Guide. 38

Dell Customer Communication - Confidential

1.10.207.81.176/backups/f30d0990-00000006-fec843f2-5bc843f2-00045000-

360c1a56",

"rel" : "item"

} ],

"name" : "E:\\file1.txt",

"retentionTime" : "2018-11-19T00:00:00-05:00",

"saveTime" : "2018-10-18T04:27:31-04:00",

"shortId" : "4274537458",

"size" : {

"unit" : "Byte",

"value" : 1680

},

"type" : "File"

}, {

"attributes" : [ {

"key" : "*backup start time",

"values" : [ "1539851225" ]

}, {

"key" : "*NSR_VSS_SHADOWCOPY_SET",

"values" : [ "{99F44A83-0BBF-49A8-B240-0970990DE6A8}" ]

}, {

"key" : "*policy action jobid",

"values" : [ "6" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1539851250" ]

}, {

"key" : "*policy name",

"values" : [ "TEST: 1539851250" ]

}, {

"key" : "*policy workflow name",

"values" : [ "TEST_WF: 1539851250" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1539851250: 1539851250:

2752349" ]

}, {

"key" : "group",

"values" : [ "TEST_PG" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-11-18T23:59:59-05:00",

"clientHostname" : "host_name_1",

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"completionTime" : "2018-10-18T04:27:30-04:00",

"creationTime" : "2018-10-18T04:27:30-04:00",

"fileCount" : 3,

NetWorker 9.1.x REST API Reference Guide. 39

Dell Customer Communication - Confidential

"id" : "627a330c-00000006-ffc843f2-5bc843f2-00035000-360c1a56",

"instances" : [ {

"clone" : false,

"id" : "1539851250",

"status" : "Browsable",

"volumeIds" : [ "13124488" ]

} ],

"level" : "Full",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176/backups/627a330c-00000006-ffc843f2-5bc843f2-00035000-

360c1a56",

"rel" : "item"

} ],

"name" : "E:\\file2.txt",

"retentionTime" : "2018-11-18T23:59:59-05:00",

"saveTime" : "2018-10-18T04:27:30-04:00",

"shortId" : "4291314674",

"size" : {

"unit" : "Byte",

"value" : 1680

},

"type" : "File"

} ],

"count" : 2

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the backups are retrieved successfully. BackupList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 40

Dell Customer Communication - Confidential

Up GET /clients/{clientId}/indexes

Returns a list of indexes. (getClientIndexes)

This operation can be used to retrieve the information about a list of indexes for the client. However, the query parameters can be used to filter the response.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance. Use pagination, if the size of the client's index database is large. You can set the desired number of entries in pagesize query filter. The NetWorker REST API uses custom header X-NW-CONTINUATION-TOKEN to paginate the output. The NetWorker server returns X-NW-CONTINUATION-TOKEN header in response if client file indexes are more than pagesize (default maximum limit is 100). The requester has to provide X-NW-CONTINUATION-TOKEN with value received in last response header to gather the next set of index records.

Request headers: This header must specify the content type of

request payload as application/json.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

IndexList

NetWorker 9.1.x REST API Reference Guide. 41

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"count" : 6,

"items" : [ {

"fileName" : "E:\\file1.txt",

"fileSizeInBytes" : 536,

"namespace" : "backup",

"offset" : 0,

"saveTime" : "2018-10-18T04:27:31-04:00"

}, {

"fileName" : "E:\\",

"fileSizeInBytes" : 784,

"namespace" : "backup",

"offset" : 536,

"saveTime" : "2018-10-18T04:27:31-04:00"

}, {

"fileName" : "/",

"fileSizeInBytes" : 356,

"namespace" : "backup",

"offset" : 1320,

"saveTime" : "2018-10-18T04:27:31-04:00"

}, {

"fileName" : "E:\\file2.txt",

"fileSizeInBytes" : 536,

"namespace" : "backup",

"offset" : 0,

"saveTime" : "2018-10-18T04:27:30-04:00"

}, {

"fileName" : "E:\\",

"fileSizeInBytes" : 784,

"namespace" : "backup",

"offset" : 536,

"saveTime" : "2018-10-18T04:27:30-04:00"

}, {

"fileName" : "/",

"fileSizeInBytes" : 356,

"namespace" : "backup",

"offset" : 1320,

"saveTime" : "2018-10-18T04:27:30-04:00"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 42

Dell Customer Communication - Confidential

application/json

Responses

200 Information about the indexes are retrieved successfully. IndexList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /clients

Returns a list of all clients. (getClients)

This operation can be used to retrieve the information about all the clients. However, the query parameters can be used to filter the response.

Query parameters

type (optional) Query Parameter The parameter "type" can be used to return additional client attributes based on the specified value from the predefined list. For example, to view advanced attributes, set the category type to "advanced", as in /clients?type=advanced. By default, if the parameter "type" is not specified, the type is "basic". default: basic

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

NetWorker 9.1.x REST API Reference Guide. 43

Dell Customer Communication - Confidential

ClientList

Example data

Content-Type: application/json

{

"clients" : [ {

"aliases" : [ "host_name_1", "localhost6" ],

"applicationInformation" : [ ],

"backupCommand" : "savepsm",

"blockBasedBackup" : false,

"checkpointEnabled" : false,

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"hostname" : "host_name_1",

"indexBackupContent" : false,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/161.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176",

"rel" : "item"

} ],

"nasDevice" : false,

"ndmp" : false,

"ndmpMultiStreamsEnabled" : false,

"ndmpVendorInformation" : [ ],

"parallelSaveStreamsPerSaveSet" : false,

"parallelism" : 12,

"protectionGroups" : [ "NMC server" ],

"remoteAccessUsers" : [ ],

"resourceId" : {

"id" : "161.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 3

},

"saveSets" : [ "C:\\Program Files\\EMC

NetWorker\\Management\\nmcdb_stage" ],

"scheduledBackup" : true,

"storageNodes" : [ "nsrserverhost" ],

"tags" : [ ]

}, {

"aliases" : [ "host_name_1", "localhost6" ],

"applicationInformation" : [ ],

"blockBasedBackup" : false,

"checkpointEnabled" : false,

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"hostname" : "host_name_1",

"indexBackupContent" : false,

"links" : [ {

NetWorker 9.1.x REST API Reference Guide. 44

Dell Customer Communication - Confidential

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/82.0.120.52.0.0.0.0.210.51.200.91

.10.207.81.176",

"rel" : "item"

} ],

"nasDevice" : false,

"ndmp" : false,

"ndmpMultiStreamsEnabled" : false,

"ndmpVendorInformation" : [ ],

"parallelSaveStreamsPerSaveSet" : false,

"parallelism" : 12,

"protectionGroups" : [ ],

"remoteAccessUsers" : [ ],

"resourceId" : {

"id" : "82.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 3

},

"saveSets" : [ "All" ],

"scheduledBackup" : true,

"storageNodes" : [ "nsrserverhost" ],

"tags" : [ ]

}, {

"aliases" : [ "host_name_1", "localhost6" ],

"applicationInformation" : [ "NSR_PS_DEBUG_LEVEL=0" ],

"backupType" : "Filesystem",

"blockBasedBackup" : false,

"checkpointEnabled" : false,

"clientId" : "d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"comment" : "Test",

"hostname" : "host_name_1",

"indexBackupContent" : false,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/clients/162.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176",

"rel" : "item"

} ],

"nasDevice" : false,

"ndmp" : false,

"ndmpMultiStreamsEnabled" : false,

"ndmpVendorInformation" : [ ],

"parallelSaveStreamsPerSaveSet" : false,

"parallelism" : 12,

"protectionGroups" : [ "TEST_PG" ],

"remoteAccessUsers" : [ ],

"resourceId" : {

"id" : "162.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 5

},

"saveSets" : [ "E:\\file1.txt", "E:\\file2.txt" ],

NetWorker 9.1.x REST API Reference Guide. 45

Dell Customer Communication - Confidential

"scheduledBackup" : true,

"storageNodes" : [ "nsrserverhost" ],

"tags" : [ ]

} ],

"count" : 3

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the clients were retrieved successfully. ClientList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /clients

Creates a new client. (postClient)

This operation can be used to create a new client.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

client Client (required) Body Parameter Client to be created.

Example request body

Content-Type: application/json

NetWorker 9.1.x REST API Reference Guide. 46

Dell Customer Communication - Confidential

{

"backupCommand":"nsrndmp_save -T dump",

"backupType":"Filesystem",

"hostname":"vnx1",

"ndmp":true,

"password":"password",

"remoteUser":"ndmpVNX7500",

"saveSets":[

"/tmp/restapi"

],

"protectionGroups":[

"NDMPAFTD_PG"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Client is created successfully. The client URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 47

Dell Customer Communication - Confidential

Up PUT /clients/{clientId}

Updates the specified client. (putClient)

This operation can be used to modify the attributes of a specific client.

Path parameters

clientId (required) Path Parameter is the value of the id attribute of the client resource's resourceId. The resourceId of the client resource uniquely identifies a client resource instance.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

client Client (required) Body Parameter Client to modify.

Example request body

Content-Type: application/json

{

"backupCommand": "nsrndmp_save -T dump",

"backupType": "Filesystem",

"hostname": "vnx1",

"ndmp": true,

"password": "password",

"remoteUser": "ndmpVNX7500",

"saveSets": [

"/tmp/restapi_new"

],

"protectionGroups": [

"NDMPAFTD_PG"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

NetWorker 9.1.x REST API Reference Guide. 48

Dell Customer Communication - Confidential

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Client is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Cloudboostappliances

Up GET /cloudboostappliances/{cloudboostapplianceId}

Returns the specific CloudBoost appliance. (getCloudBoostAppliance)

This operation can be used to retrieve the information about the specific CloudBoost appliance.

Path parameters

cloudboostapplianceId (required) Path Parameter is the value of the id attribute of the CloudBoost resource's resourceId.

Return type

CloudboostAppliance

Example data

Content-Type: application/json

NetWorker 9.1.x REST API Reference Guide. 49

Dell Customer Communication - Confidential

{

"host" : "10.234.165.138",

"name" : "10.234.165.138",

"password" : "*******",

"resourceId" : {

"id" : "45.0.248.7.0.0.0.0.156.112.46.90.10.234.165.139",

"sequence" : 7

},

"username" : "maginatics"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 CloudBoost appliance information is retrieved successfully. CloudboostAppliance

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /cloudboostappliances

Returns a list of CloudBoost appliances. (getCloudBoostAppliances)

This operation can be used to retrieve the information about all the registered CloudBoost appliances. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter,

NetWorker 9.1.x REST API Reference Guide. 50

Dell Customer Communication - Confidential

for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

CloudboostApplianceList

Example data

Content-Type: application/json

{

"cloudBoostAppliances" : [ {

"host" : "10.234.165.138",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/cloudboostappliances/45.0.248.7.0.0.0.0.1

56.112.46.90.10.234.165.139",

"rel" : "item"

} ],

"name" : "10.234.165.138",

"password" : "*******",

"resourceId" : {

"id" : "45.0.248.7.0.0.0.0.156.112.46.90.10.234.165.139",

"sequence" : 7

},

"username" : "maginatics"

} ],

"count" : 1

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

NetWorker 9.1.x REST API Reference Guide. 51

Dell Customer Communication - Confidential

Information about the cloudboost appliances are retrieved successfully. CloudboostApplianceList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Datadomainsystems

Up GET /datadomainsystems

Returns a list of Data Domain systems. (getDataDomainSystems)

This operation can be used to retrieve the information about all the Data Domain systems. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

DataDomainSystemList

Example data

Content-Type: application/json

{

NetWorker 9.1.x REST API Reference Guide. 52

Dell Customer Communication - Confidential

"count" : 1,

"dataDomainSystems" : [ {

"availableCapacity" : "365 TB",

"hosts" : "10.118.157.101",

"inuseFilecopyStreams" : "0",

"inuseReadStreams" : "0",

"inuseReadWriteStreams" : "16",

"inuseReplicationStreams" : "0",

"managementPort" : "3009",

"maxReadStreams" : "300",

"maxReplicationDestinationStreams" : "1080",

"maxReplicationSourceStreams" : "540",

"maxWriteStreams" : "1885",

"model" : "DD9800",

"name" : "10.118.157.101",

"osVersion" : "Data Domain OS 6.1.1.5-582414",

"serial" : "CKM00180702176",

"storageNode" : "nsrserverhost",

"totalCapacity" : "365 TB",

"totalMaxStreams" : "3994",

"totalMaxWriteStreams" : "2290",

"usedCapacity" : "129 GB",

"usedLogicalCapacity" : "2852 GB",

"userName" : "ost"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the Data Domain systems are retrieved successfully. DataDomainSystemList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 53

Dell Customer Communication - Confidential

Devices

Up DELETE /devices/{deviceId}

Deletes the specific device. (deleteDevice)

This operation can be used to delete a specific device from NetWorker. A device represents a storage unit that can contain a backup volume. A device can be a tape device, optical drive, or disk connected to the server or storage node.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Device is deleted successfully from NetWorker. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /devices/{deviceId}

Returns the specific device. (getDevice)

NetWorker 9.1.x REST API Reference Guide. 54

Dell Customer Communication - Confidential

This operation can fetch the information about the specific device. A device represents a storage unit that can contain a backup volume. A device can be a tape device, optical drive, or disk connected to the server or storage node.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Device

Example data

Content-Type: application/json

{

"autoMediaManagement" : false,

"cdi" : "NotUsed",

"cleaningRequired" : false,

"dataDomainFibreChannel" : false,

"dataDomainRetentionLockMode" : "None",

"deviceAccessInfo" : "/space/storage",

"dltWormCapable" : false,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/devices/%252Fspace%252Fstorage/opstatus",

"title" : "Volume operation status"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/devices/%252Fspace%252Fstorage/op/label",

"title" : "Label volume"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/devices/%252Fspace%252Fstorage/op/mount",

"title" : "Mount volume"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/devices/%252Fspace%252Fstorage/op/unmount

",

"title" : "Unmount volume"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/devices/%252Fspace%252Fstorage/op/verifyl

abel",

"title" : "Verify volume label"

} ],

NetWorker 9.1.x REST API Reference Guide. 55

Dell Customer Communication - Confidential

"maxNsrmmdCount" : 12,

"maxSession" : 32,

"mediaFamily" : "Disk",

"mediaType" : "adv_file",

"name" : "/space/storage",

"ndmp" : false,

"readOnly" : false,

"resourceId" : {

"id" : "46.0.255.77.0.0.0.0.98.147.197.91.example.com",

"sequence" : 1

},

"status" : "Enabled",

"suspectedDevice" : false,

"tapeAlertsCritical" : [ ],

"tapeAlertsInformation" : [ ],

"tapeAlertsWarning" : [ ],

"targetSession" : 4,

"verifyLabelOnEject" : false,

"volumePool" : "",

"warnOnSuspectVolumesInPercent" : 80,

"wormCapable" : false,

"wormCartridgePresent" : false,

"writeEnabled" : true

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific device is retrieved successfully. Device

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /devices/{deviceId}/opstatus

Returns the status of the specific device. (getDeviceOpStatus)

NetWorker 9.1.x REST API Reference Guide. 56

Dell Customer Communication - Confidential

This operation can be used to retrieve the status of the device. The device name uniquely identifies a device resource instance.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

DeviceOpStatus

Example data

Content-Type: application/json

{

"operationInProgress" : false,

"resourceId" : {

"id" : "46.0.255.77.0.0.0.0.98.147.197.91.10.118.244.205",

"sequence" : 9

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Status of the device is retrieved successfully. DeviceOpStatus

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /devices

NetWorker 9.1.x REST API Reference Guide. 57

Dell Customer Communication - Confidential

Returns a list of devices. (getDevices)

This operation can be used to retrieve the information about all the devices. However, the query parameters can be used to filter the response. A device represents a storage unit that can contain a backup volume. A device can be a tape device, optical drive, or disk connected to the server or storage node.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

DeviceList

Example data

Content-Type: application/json

{

"count" : 1,

"devices" : [ {

"autoMediaManagement" : false,

"cdi" : "NotUsed",

"cleaningRequired" : false,

"dataDomainFibreChannel" : false,

"dataDomainRetentionLockMode" : "None",

"deviceAccessInfo" : "/space/storage",

"dltWormCapable" : false,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/devices/%252Fspace%252Fstorage",

"rel" : "item"

} ],

"maxNsrmmdCount" : 12,

"maxSession" : 32,

NetWorker 9.1.x REST API Reference Guide. 58

Dell Customer Communication - Confidential

"mediaFamily" : "Disk",

"mediaType" : "adv_file",

"name" : "/space/storage",

"ndmp" : false,

"readOnly" : false,

"resourceId" : {

"id" : "46.0.255.77.0.0.0.0.98.147.197.91.10.118.244.205",

"sequence" : 1

},

"status" : "Enabled",

"suspectedDevice" : false,

"tapeAlertsCritical" : [ ],

"tapeAlertsInformation" : [ ],

"tapeAlertsWarning" : [ ],

"targetSession" : 4,

"verifyLabelOnEject" : false,

"volumePool" : "",

"warnOnSuspectVolumesInPercent" : 80,

"wormCapable" : false,

"wormCartridgePresent" : false,

"writeEnabled" : true

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the devices are retrieved successfully. DeviceList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /devices/{deviceId}/op/label

Creates a label for the specific device resource. The device name uniquely identifies a device resource instance. (postDeviceOpLabel)

NetWorker 9.1.x REST API Reference Guide. 59

Dell Customer Communication - Confidential

This operation can be used to label a specific device. NetWorker uses the volume labels to maintain a record of each backup volume in the online media index.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

deviceOpLabel DeviceOpLabel (required) Body Parameter Device label to be applied.

Example request body

Content-Type: application/json

{

"labelWithoutMount": "false",

"pool": "Default"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

InfoResponse

Example data

Content-Type: application/json

{

"text" : "The request is accepted. To retrieve its status, issue an

HTTP GET request to URL specified in the 'Location' response header."

}

NetWorker 9.1.x REST API Reference Guide. 60

Dell Customer Communication - Confidential

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 Request to label has been accepted. InfoResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /devices/{deviceId}/op/mount

Mounts a volume into a device. (postDeviceOpMount)

This operation can be used to mount a volume into a device. A backup volume must be mounted before NetWorker can use it to back up or recover files.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

NetWorker 9.1.x REST API Reference Guide. 61

Dell Customer Communication - Confidential

deviceOpMount DeviceOpMount (required) Body Parameter Mount information.

Example request body

Content-Type: application/json

{

"volume": "rhel67_base.002",

"writeEnabled": true

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

InfoResponse

Example data

Content-Type: application/json

{

"text" : "The request is accepted. To retrieve its status, issue an

HTTP GET request to URL specified in the 'Location' response header."

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 Mount request has been accepted. InfoResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500

NetWorker 9.1.x REST API Reference Guide. 62

Dell Customer Communication - Confidential

InternalServerErrorResponse

Up POST /devices/{deviceId}/op/unmount

Unmounts a volume from the specific device. (postDeviceOpUnmount)

This operation can be used to unmount a volume from a device.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body object (optional) Body Parameter

Example request body

Content-Type: application/json

{}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

InfoResponse

Example data

Content-Type: application/json

{

"text" : "The request is accepted. To retrieve its status, issue an

HTTP GET request to URL specified in the 'Location' response header."

NetWorker 9.1.x REST API Reference Guide. 63

Dell Customer Communication - Confidential

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 Unmount request has been accepted. InfoResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /devices/{deviceId}/op/verifylabel

Verifies the label in the specific device. (postDeviceOpVerifyLabel)

This operation can be used to verify the device label. Note: Verifying a label unmounts the mounted volumes. NetWorker uses the volume labels to maintain a record of each backup volume in the online media index.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

NetWorker 9.1.x REST API Reference Guide. 64

Dell Customer Communication - Confidential

Request body

body object (optional) Body Parameter

Example request body

Content-Type: application/json

{}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

InfoResponse

Example data

Content-Type: application/json

{

"text" : "The request is accepted. To retrieve its status, issue an

HTTP GET request to URL specified in the 'Location' response header."

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 The request to verify the device label has been accepted. InfoResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 65

Dell Customer Communication - Confidential

Up POST /devices

Creates a new device. (postDevices)

This operation can be used to create a new device. A device represents a storage unit that can contain a backup volume. A device can be a tape device, optical drive, or disk connected to the server or storage node.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

device Device (required) Body Parameter Device to be created.

Example request body

Content-Type: application/json

{

"name": "/space/storage",

"deviceAccessInfo": "/space/storage",

"mediaType": "adv_file"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 66

Dell Customer Communication - Confidential

201 Device is created successfully. The device resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /devices/{deviceId}

Updates the specific device. (putDevice)

This operation can be used to modify the attributes of a specific device.

Path parameters

deviceId (required) Path Parameter is the value of the name attribute in the device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

device Device (required) Body Parameter Device attributes to be updated.

Example request body

Content-Type: application/json

{

"autoMediaManagement": true,

"cdi": "NotUsed",

"targetSession": 5,

NetWorker 9.1.x REST API Reference Guide. 67

Dell Customer Communication - Confidential

"verifyLabelOnEject": false,

"volumePool": "",

"warnOnSuspectVolumesInPercent": 81,

"wormCapable": false,

"wormCartridgePresent": false,

"writeEnabled": true

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Device attributes updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Directives

Up DELETE /directives/{directiveId}

Deletes the specific directive. (deleteDirective)

This operation can be used to delete the specific directive. Directives can be created to provide special instructions at the client level. A directive

NetWorker 9.1.x REST API Reference Guide. 68

Dell Customer Communication - Confidential

can be defined to skip certain directories or file types, to compress backup data, or to encrypt backup data.

Path parameters

directiveId (required) Path Parameter is the value of the name attribute in the directive resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Directive is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /directives/{directiveId}

Returns the specific directive. (getDirective)

This operation can fetch the information about the specific directive. Directives can be created to provide special instructions at the client level. A directive can be defined to skip certain directories or file types, to compress backup data, or to encrypt backup data.

Path parameters

directiveId (required)

NetWorker 9.1.x REST API Reference Guide. 69

Dell Customer Communication - Confidential

Path Parameter is the value of the name attribute in the directive resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Directive

Example data

Content-Type: application/json

{

"comment" : "Example Directive",

"links" : [ ],

"name" : "Directive Name",

"resourceId" : {

"id" : "170.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the directive is retrieved successfully. Directive

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /directives

Returns a list of directives. (getDirectives)

This operation can be used to retrieve the information about all the directives. However, the query parameters can be used to filter the response. Directives can be created to provide special instructions at the client level. A directive

NetWorker 9.1.x REST API Reference Guide. 70

Dell Customer Communication - Confidential

can be defined to skip certain directories or file types, to compress backup data, or to encrypt backup data.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

DirectiveList

Example data

Content-Type: application/json

{

"count" : 2,

"directives" : [ {

"directive" : "\n<< / >>\n\tskip: tmp_mnt\n\t+skip:

core\n\t+compressasm: .\n<< /tmp >>\n\tskip: .?* *\n<< /export/swap

>>\n\tswapasm: .\n<< /nsr >>\n\tallow\n<< /nsr/logs >>\n\tlogasm:

.\n<< /var >>\n\tlogasm: *\n<< /usr/adm >>\n\tlogasm: .\n<<

/usr/spool >>\n\tlogasm: .\n<< /usr/spool/mail >>\n\tmailasm: .\n<<

/usr/mail >>\n\tmailasm: .\n",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/directives/Unix%2Bwith%2Bcompression%2Bdi

rectives",

"rel" : "item"

} ],

"name" : "Unix with compression directives",

"resourceId" : {

"id" : "46.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

}, {

"links" : [ {

NetWorker 9.1.x REST API Reference Guide. 71

Dell Customer Communication - Confidential

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/directives/VCB%2Bdirective",

"rel" : "item"

} ],

"name" : "VCB directive",

"resourceId" : {

"id" : "50.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the driectives are retrieved successfully. DirectiveList

Example data

Content-Type: application/json

{count=2, directives=[{directive=

<< / >>

skip: tmp_mnt

+skip: core

+compressasm: .

<< /tmp >>

skip: .?* *

<< /export/swap >>

swapasm: .

<< /nsr >>

allow

<< /nsr/logs >>

logasm: .

<< /var >>

logasm: *

<< /usr/adm >>

logasm: .

<< /usr/spool >>

logasm: .

<< /usr/spool/mail >>

mailasm: .

<< /usr/mail >>

mailasm: .

NetWorker 9.1.x REST API Reference Guide. 72

Dell Customer Communication - Confidential

, links=[{href=https://networker-

ip:9090/nwrestapi/v3/global/directives/Unix%2Bwith%2Bcompression%2Bdi

rectives, rel=item}], name=Unix with compression directives,

resourceId={id=46.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176,

sequence=1}}, {links=[{href=https://networker-

ip:9090/nwrestapi/v3/global/directives/VCB%2Bdirective, rel=item}],

name=VCB directive,

resourceId={id=50.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176,

sequence=1}}]}

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /directives

Creates a new directive. (postDirectives)

This operation can be used to create a directive. Directives can be created to provide special instructions at the client level. A directive can be defined to skip certain directories or file types, to compress backup data, or to encrypt backup data.

Request body

directive Directive (required) Body Parameter Directive to be created.

Example request body

Content-Type: application/json

{

"name": "unix with compression directives",

"directive": "\n<< / >>\n\t+compressasm: .\n",

"comment": "Example Directive"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

NetWorker 9.1.x REST API Reference Guide. 73

Dell Customer Communication - Confidential

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 The directive is created successfully. The directive resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /directives/{directiveId}

Updates the specific directive. (putDirective)

This operation can be used to modify the specific directive. Directives can be created to provide special instructions at the client level. A directive can be defined to skip certain directories or file types, to compress backup data, or to encrypt backup data.

Path parameters

directiveId (required) Path Parameter is the value of the name attribute in the directive resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

directive Directive (required) Body Parameter Directive data for update.

Example request body

Content-Type: application/json

NetWorker 9.1.x REST API Reference Guide. 74

Dell Customer Communication - Confidential

{

"directive": "\n<< / >>\n\tskip: tmp_mnt\n\t+skip:

core\n\t+compressasm: .\n<< /tmp >>\n\tskip: .?* *\n<< /export/swap

>>\n\tswapasm: .\n<< /nsr >>\n\tallow\n<< /nsr/logs >>\n\tlogasm:

.\n<< /var >>\n\tlogasm: *\n<< /usr/adm >>\n\tlogasm: .\n<<

/usr/spool >>\n\tlogasm: .\n<< /usr/spool/mail >>\n\tmailasm: .\n<<

/usr/mail >>\n\tmailasm: .\n",

"comment": "This Directive updated "

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Directive is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Jobs

Up GET /jobs/{jobId}

Returns the specific job. (getJob)

NetWorker 9.1.x REST API Reference Guide. 75

Dell Customer Communication - Confidential

This operation can fetch the information about the specific job. The job is a generic label for performing any operations, such as savefs, save, archive, index, and recover operations. NetWorker removes the job information from the job database based on value of the jobsdb retention in hours attribute in the properties of the NetWorker server resource. The default jobsdb retention is 72 hours.

Path parameters

jobId (required) Path Parameter is the value of the id attribute in the job resource. It is a numeric value that uniquely identifies a job resource instance.

Return type

Job

Example data

Content-Type: application/json

{

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -s host_name_1 -p TEST -

w TEST_WF -L",

"completionStatus" : "Succeeded",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-18T04:27:51-04:00",

"exitCode" : 0,

"id" : 5,

"itemIdLong" : 5,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/5/log",

"title" : "View job log"

} ],

"logFile" : "C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\TEST\\workflow_TEST_WF_000005.raw",

"message" : "133550 1539851212 1 0 0 14548 13976 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 4 TEST 0 7 TEST_WF\n123316 1539851212 1 0

0 14548 13976 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 32

savegrp -Z backup:traditional -v\n123321 1539851212 1 0 0 14548 13976

0 host_name_1 nsrworkflow NSR notice 39 Action '%s/%s/%s's log will

be in '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 23 77 C:\\Program

Files\\EMC

NetWorker\\nsr\\logs\\policy\\TEST\\TEST_WF\\backup_000006.raw\n12332

5 1539851271 1 0 0 14548 13976 0 host_name_1 nsrworkflow NSR notice

21 Action '%s/%s/%s' %s. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 9

succeeded\n133553 1539851271 1 0 0 14548 13976 0 host_name_1

nsrworkflow NSR notice 27 Workflow '%s/%s' succeeded. 2 0 4 TEST 0 7

TEST_WF\n",

"name" : "TEST",

NetWorker 9.1.x REST API Reference Guide. 76

Dell Customer Communication - Confidential

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/1/0",

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-18T04:26:52-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

"workflowName" : "TEST_WF"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific job is retrieved successfully. Job

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /jobgroups/{jobGroupId}

Returns a list of jobs that belong to the job group. (getJobGroup)

This operation can fetch the information about the specific job group.

Path parameters

jobGroupId (required) Path Parameter is the value of the id attribute in the job group resource.

Return type

NetWorker 9.1.x REST API Reference Guide. 77

Dell Customer Communication - Confidential

JobList

Example data

Content-Type: application/json

{

"count" : 1,

"jobs" : [ {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrtask.exe\" -C DefaultNsrclientfixTask",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-20T07:00:01-04:00",

"exitCode" : 1,

"id" : 49,

"itemIdLong" : 49,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/49",

"rel" : "item"

} ],

"name" : "DefaultNsrclientfixTask",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-20T07:00:01-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "task job"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific job group is retrieved successfully. JobList

400 BadRequestErrorResponse

NetWorker 9.1.x REST API Reference Guide. 78

Dell Customer Communication - Confidential

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /jobgroups

Returns a list of job groups. (getJobGroups)

This operation can be used to retrieve the information about all the job groups. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

JobList

Example data

Content-Type: application/json

{

"count" : 3,

"jobs" : [ {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -p TEST -w TEST_WF -a -L

-c host_name_1",

"completionStatus" : "Succeeded",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T01:21:00-04:00",

NetWorker 9.1.x REST API Reference Guide. 79

Dell Customer Communication - Confidential

"exitCode" : 0,

"id" : 107,

"itemIdLong" : 107,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobgroups/107",

"rel" : "item"

} ],

"logFile" : " ",

"message" : "133550 1540272002 1 0 0 13704 14612 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 4 TEST 0 7 TEST_WF\n123316 1540272002 1 0

0 13704 14612 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 32

savegrp -Z backup:traditional -v\n123321 1540272002 1 0 0 13704 14612

0 host_name_1 nsrworkflow NSR notice 39 Action '%s/%s/%s's log will

be in '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 23 77 C: 1540272060 1 0

0 13704 14612 0 host_name_1 nsrworkflow NSR notice 21 Action

'%s/%s/%s' %s. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 9

succeeded\n133553 1540272060 1 0 0 13704 14612 0 host_name_1

nsrworkflow NSR notice 27 Workflow '%s/%s' succeeded. 2 0 4 TEST 0 7

TEST_WF\n",

"name" : "TEST",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/1/0",

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T01:20:02-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

"workflowName" : "TEST_WF"

}, {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -s host_name_1 -p TEST -

w TEST_WF -L",

"completionStatus" : "Succeeded",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-22T21:00:59-04:00",

"exitCode" : 0,

"id" : 101,

"itemIdLong" : 101,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobgroups/101",

"rel" : "item"

} ],

NetWorker 9.1.x REST API Reference Guide. 80

Dell Customer Communication - Confidential

"logFile" : " ",

"message" : "133550 1540256401 1 0 0 17208 16312 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 4 TEST 0 7 TEST_WF\n123316 1540256401 1 0

0 17208 16312 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 32

savegrp -Z backup:traditional -v\n123321 1540256401 1 0 0 17208 16312

0 host_name_1 nsrworkflow NSR notice 39 Action '%s/%s/%s's log will

be in '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 23 77 C: 1540256459 1 0

0 17208 16312 0 host_name_1 nsrworkflow NSR notice 21 Action

'%s/%s/%s' %s. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 9

succeeded\n133553 1540256459 1 0 0 17208 16312 0 host_name_1

nsrworkflow NSR notice 27 Workflow '%s/%s' succeeded. 2 0 4 TEST 0 7

TEST_WF\n",

"name" : "TEST",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/1/0",

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-22T21:00:01-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

"workflowName" : "TEST_WF"

}, {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrtask.exe\" -C DefaultNsrclientfixTask",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-20T07:00:01-04:00",

"exitCode" : 1,

"id" : 49,

"itemIdLong" : 49,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobgroups/49",

"rel" : "item"

} ],

"name" : "DefaultNsrclientfixTask",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-20T07:00:01-04:00",

"state" : "Completed",

NetWorker 9.1.x REST API Reference Guide. 81

Dell Customer Communication - Confidential

"stopped" : true,

"tenant" : "",

"type" : "task job"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the job groups are retrieved successfully. JobList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /jobindications

Returns a list of job indications. (getJobIndications)

This operation can be used to retrieve the information about all the job indications. However, the query parameters can be used to filter the response. Job indications are messages sent to job daemon by the clients if it encounters any interruption during the execution.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional)

NetWorker 9.1.x REST API Reference Guide. 82

Dell Customer Communication - Confidential

Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

JobIndicationList

Example data

Content-Type: application/json

{

"count" : 3,

"jobIndications" : [ {

"jobId" : 192026,

"message" : "Unable to find any full backups of the save set

'10.31.227.131:/tools_mnt/lgtonode-99.0.99.8841-1.x86_64.rpm' in the

media database. Recommending that a full backup be performed.\n",

"messageId" : "0",

"originComponent" : "Savegroup",

"severity" : "Information",

"timestamp" : "2018-10-30T09:08:55+05:30"

}, {

"jobId" : 128061,

"message" : "ncdqd131:/nsr/nmc/nmcdb_stage: retried 1 times.\n",

"messageId" : "0",

"originComponent" : "Savegroup",

"severity" : "Information",

"timestamp" : "2018-10-28T14:00:40+05:30"

}, {

"jobId" : 128048,

"message" : "ncdqd131:/nsr/nmc/nmcdb_stage: retried 1 times.\n",

"messageId" : "0",

"originComponent" : "Savegroup",

"severity" : "Information",

"timestamp" : "2018-10-27T14:00:40+05:30"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

NetWorker 9.1.x REST API Reference Guide. 83

Dell Customer Communication - Confidential

Responses

200 Information about the job indications are retrieved successfully. JobIndicationList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /jobs/{jobId}/log

Returns the log file for a specific job. (getJobLog)

This operation can fetch the log file associated with the specific job. NetWorker removes the job information from the job database based on value of the jobsdb retention in hours attribute in the properties of the NetWorker server resource. The default jobsdb retention is 72 hours.

Path parameters

jobId (required) Path Parameter is the value of the id attribute in the job resource. It is a numeric value that uniquely identifies a job resource instance.

Example data

Content-Type: application/octet-stream

"133550 1540272002 1 0 0 13704 14612 0 host_name_1 nsrworkflow NSR

notice 31 Starting %s '%s' workflow '%s'. 3 11 24 127405:Protection

Policy 0 4 TEST 0 7 TEST_WF\n123316 1540272002 1 0 0 13704 14612 0

host_name_1 nsrworkflow NSR notice 46 Starting action '%s/%s/%s' with

command: '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 32 savegrp -Z

backup:traditional -v\n123321 1540272002 1 0 0 13704 14612 0

host_name_1 nsrworkflow NSR notice 39 Action '%s/%s/%s's log will be

in '%s'. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 23 77 C:\\Program

Files\\EMC

NetWorker\\nsr\\logs\\policy\\TEST\\TEST_WF\\backup_000108.raw\n12332

5 1540272060 1 0 0 13704 14612 0 host_name_1 nsrworkflow NSR notice

21 Action '%s/%s/%s' %s. 4 0 4 TEST 0 7 TEST_WF 0 6 backup 0 9

succeeded\n133553 1540272060 1 0 0 13704 14612 0 host_name_1

nsrworkflow NSR notice 27 Workflow '%s/%s' succeeded. 2 0 4 TEST 0 7

TEST_WF \n\n"

Produces

NetWorker 9.1.x REST API Reference Guide. 84

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/octet-stream

Responses

200 Information about the specific job file is retrieved successfully.

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /jobs

Returns a list of jobs. (getJobs)

This operation can be used to retrieve the information about all the job instances. However, the query parameters can be used to filter the response. The job is a generic label for performing any operations, such as savefs, save, archive, index, and recover operations. Note: NetWorker removes the job information from the job database based on value of the jobsdb retention in hours attribute in the properties of the NetWorker server resource. The default jobsdb retention is 72 hours.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both

NetWorker 9.1.x REST API Reference Guide. 85

Dell Customer Communication - Confidential

filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

JobList

Example data

Content-Type: application/json

{

"count" : 3,

"jobs" : [ {

"adhocJob" : false,

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-18T04:25:50-04:00",

"exitCode" : 0,

"id" : 3,

"itemIdLong" : 3,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/3",

"rel" : "item"

} ],

"name" : "nsrfsra",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-18T04:25:23-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "generic remote command"

}, {

"adhocJob" : false,

"command" : "nsrfsra",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-18T04:25:05-04:00",

"exitCode" : 0,

"id" : 2,

"itemIdLong" : 2,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/2",

"rel" : "item"

} ],

"name" : "nsrfsra",

"ndmp" : false,

NetWorker 9.1.x REST API Reference Guide. 86

Dell Customer Communication - Confidential

"parentJobId" : 1,

"previousJobId" : 0,

"rootParentJobId" : 1,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-18T04:24:47-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "generic remote command"

}, {

"adhocJob" : false,

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-18T04:25:05-04:00",

"exitCode" : 0,

"id" : 1,

"itemIdLong" : 1,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/1",

"rel" : "item"

} ],

"name" : "nsrfsra",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-18T04:24:47-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "generic remote command"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the jobs are retrieved successfully. JobList

400

NetWorker 9.1.x REST API Reference Guide. 87

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /jobs/{jobId}/op/cancel

Cancels the specific job. (postJobOpCancel)

This operation can be used to cancel a specific job.

Path parameters

jobId (required) Path Parameter is the value of the id attribute in the job resource. It attribute is a numeric value that uniquely identifies a job resource instance.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

jobOpCancel JobOpCancel (required) Body Parameter Empty JSON body as a parameter.

Example request body

Content-Type: application/json

{}

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 88

Dell Customer Communication - Confidential

application/json

Responses

202 Job cancellation request is accepted.

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Labels

Up DELETE /labels/{labelId}

Deletes the specific label. (deleteLabel)

This operation can be used to delete the specific label. A label represents a template used to generate volume labels.

Path parameters

labelId (required) Path Parameter is the value of the name attribute in the label resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 89

Dell Customer Communication - Confidential

204 Information about the label is retrieved successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /labels/{labelId}

Returns the specific label. (getLabel)

This operation can fetch the information about the specific label. A label represents a template used to generate volume labels.

Path parameters

labelId (required) Path Parameter is the value of the name attribute in the label resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Label

Example data

Content-Type: application/json

{

"comment" : "Example Label",

"fields" : [ "backup", "001-999" ],

"links" : [ ],

"name" : "Label Name",

"next" : "backup.001",

"resourceId" : {

"id" : "172.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"separator" : "."

}

Produces

NetWorker 9.1.x REST API Reference Guide. 90

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the label is retrieved successfully. Label

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /labels

Returns a list of labels. (getLabels)

This operation can be used to retrieve the information about all the labels. However, the query parameters can be used to filter the response. A Label describes the templates used to generate volume labels.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

NetWorker 9.1.x REST API Reference Guide. 91

Dell Customer Communication - Confidential

LabelList

Example data

Content-Type: application/json

{

"count" : 2,

"labels" : [ {

"fields" : [ "bob_restapi_c", "pcarchive", "001-999" ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/labels/PC%2BArchive%2BClone",

"rel" : "item"

} ],

"name" : "PC Archive Clone",

"next" : "bob_restapi_c.pcarchive.001",

"resourceId" : {

"id" : "96.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"separator" : "."

}, {

"fields" : [ "bob_restapi", "001-999", "a-b" ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/labels/Two%2BSided",

"rel" : "item"

} ],

"name" : "Two Sided",

"next" : "bob_restapi.001.a",

"resourceId" : {

"id" : "90.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"separator" : "."

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the labels are retrieved successfully. LabelList

400

NetWorker 9.1.x REST API Reference Guide. 92

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /labels

Creates a new label. (postLabel)

This operation can be used to create a label. A label represents a template used to generate volume labels.

Request body

label Label (required) Body Parameter Label to be created.

Example request body

Content-Type: application/json

{

"comment": "Example Label",

"fields": [

"backup",

"001-999"

],

"name": "Label Name",

"separator": "."

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 93

Dell Customer Communication - Confidential

application/json

Responses

201 A new label created successfully. The label resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /labels/{labelId}

Updates the specific label. (putLabel)

This operation can be used to update the specific label. A label represents a template used to generate volume labels.

Path parameters

labelId (required) Path Parameter is the value of the name attribute in the label resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

label Label (required) Body Parameter Label data for update.

Example request body

Content-Type: application/json

{

"comment": "Updated example label",

"fields": [

"backup",

"001-998"

]

}

NetWorker 9.1.x REST API Reference Guide. 94

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Label is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Licenses

Up GET /licenses/{licenseId}

Returns the specific license. (getLicense)

This operation can fetch the information about the specific license. A license resource provides information about a NetWorker license.

Path parameters

licenseId (required) Path Parameter is the value of the id attribute of the license resource's resourceId.

Return type

NetWorker 9.1.x REST API Reference Guide. 95

Dell Customer Communication - Confidential

License

Example data

Content-Type: application/json

{

"enablerCode" : "none",

"expirationDate" : "2019-01-14T00:00:00-05:00",

"hostId" : "760acdf4",

"licenseType" : "E10",

"name" : "NetWorker/10 Eval",

"resourceId" : {

"id" : "33.0.251.12.0.0.0.0.53.59.196.91.10.118.244.205",

"sequence" : 1

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specified license is retrieved successfully. License

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /licenses

Returns a list of licenses. (getLicenses)

This operation can be used to retrieve the information about all the licenses. However, the query parameters can be used to filter the response. A license resource provides information about a NetWorker license.

Query parameters

q (optional)

NetWorker 9.1.x REST API Reference Guide. 96

Dell Customer Communication - Confidential

Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

LicenseList

Example data

Content-Type: application/json

{

"count" : 1,

"licenses" : [ {

"enablerCode" : "none",

"expirationDate" : "2019-01-14T00:00:00-05:00",

"hostId" : "760acdf4",

"licenseType" : "E10",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/licenses/33.0.251.12.0.0.0.0.53.59.196.91

.10.118.244.205",

"rel" : "item"

} ],

"name" : "NetWorker/10 Eval",

"resourceId" : {

"id" : "33.0.251.12.0.0.0.0.53.59.196.91.10.118.244.205",

"sequence" : 1

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 97

Dell Customer Communication - Confidential

application/json

Responses

200 Information about the licenses are retrieved successfully. LicenseList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Nasdevices

Up DELETE /nasdevices/{nasdeviceId}

Deletes the specific NAS device. (deleteNasDevice)

This operation can be used to delete a specific NAS device from NetWorker.

Path parameters

nasdeviceId (required) Path Parameter is the value of the name attribute in the NAS device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 NAS Device is deleted successfully from NetWorker. EmptyResponse

400

NetWorker 9.1.x REST API Reference Guide. 98

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /nasdevices/{nasdeviceId}

Returns the specific NAS device. (getNasDevice)

This operation can fetch the information about the specific NAS device.

Path parameters

nasdeviceId (required) Path Parameter is the value of the name attribute in the NAS device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

NASDevice

Example data

Content-Type: application/json

{

"comment" : "Updating the NAS device",

"name" : "ISILON",

"nasDeviceManagementName" : "ndmp",

"nasManagementPassword" : "*******",

"nasManagementUser" : "root",

"resourceId" : {

"id" : "209.0.212.14.0.0.0.0.73.140.56.92.10.118.149.220",

"sequence" : 2

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

NetWorker 9.1.x REST API Reference Guide. 99

Dell Customer Communication - Confidential

Responses

200 Information about the specific NAS device is retrieved successfully. NASDevice

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /nasdevices

Returns a list of NAS devices. (getNasDevices)

This operation can be used to retrieve the information about all the NAS devices. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

NASDeviceList

Example data

Content-Type: application/json

{

"count" : 1,

"nasDevices" : [ {

NetWorker 9.1.x REST API Reference Guide. 100

Dell Customer Communication - Confidential

"comment" : "Updating the NAS device",

"links" : [ {

"href" :

"https://10.118.149.220:9090/nwrestapi/v3/global/nasdevices/ISILON",

"rel" : "item"

} ],

"name" : "ISILON",

"nasDeviceManagementName" : "ndmp",

"nasManagementPassword" : "*******",

"nasManagementUser" : "root",

"resourceId" : {

"id" : "209.0.212.14.0.0.0.0.73.140.56.92.10.118.149.220",

"sequence" : 2

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the NAS Devices are retrieved successfully. NASDeviceList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /nasdevices

Creates a new NAS device. (postNasDevices)

This operation can be used to create a new NAS device.

Consumes

This API call consumes the following media types via the Content-Type request header:

NetWorker 9.1.x REST API Reference Guide. 101

Dell Customer Communication - Confidential

application/json

Request body

device NASDevice (required) Body Parameter NAS Device to be created.

Example request body

Content-Type: application/json

{

"name": "ISILON",

"nasManagementPassword": "Sfe234RTz",

"nasManagementUser": "root"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 NAS Device is created successfully. The NAS Device resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /nasdevices/{nasdeviceId}

NetWorker 9.1.x REST API Reference Guide. 102

Dell Customer Communication - Confidential

Updates the specific NAS device. (putNasDevice)

This operation can be used to modify the attributes of a specific NAS device.

Path parameters

nasdeviceId (required) Path Parameter is the value of the name attribute in the NAS device resource. The device name uniquely identifies a device resource instance. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

device Device (required) Body Parameter NAS Device attributes to be updated.

Example request body

Content-Type: application/json

{

"comment": "Updating the NAS device",

"nasDeviceManagementName": "ndmp"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

NetWorker 9.1.x REST API Reference Guide. 103

Dell Customer Communication - Confidential

Responses

204 NAS Device attributes updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Notifications

Up DELETE /notifications/{notificationId}

Deletes the specific notification. (deleteNotification)

This operation can be used to delete a specific notification. Notification serves as a means to attach an event of interest to a specific action, where the action can be a command or custom script to be run.

Path parameters

notificationId (required) Path Parameter is the value of the name attribute in the notification resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

NetWorker 9.1.x REST API Reference Guide. 104

Dell Customer Communication - Confidential

Notification instance is deleted successfully from NetWorker. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /notifications/{notificationId}

Returns information about the specific notification. (getNotification)

This operation can be used to retrieve the information about the specific notification. Notification serves as a means to attach an event of interest to a specific action, where the action can be a command or custom script to be run. For example, a notification can be configured to send email for a certain type of event.

Path parameters

notificationId (required) Path Parameter is the value of the name attribute in the notification resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Notification

Example data

Content-Type: application/json

{

"action" : "smtpmail -h mailhost -s \"host : Bus/Device reset

detected\" Administrators",

"events" : [ "BusDeviceReset" ],

"name" : "Bus/Device Reset",

"priorities" : [ "Alert", "Warning" ],

"resourceId" : {

"id" : "9.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

}

Produces

NetWorker 9.1.x REST API Reference Guide. 105

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the notification is retrieved successfully. Notification

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /notifications

Returns a list of notifications. (getNotifications)

This operation can be used to retrieve a list of notifications. However, the query parameters can be used to filter the response. Notification serves as a means to attach an event of interest to a specific action, where the action can be a command or custom script to be run.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

NetWorker 9.1.x REST API Reference Guide. 106

Dell Customer Communication - Confidential

Return type

NotificationList

Example data

Content-Type: application/json

{

"count" : 2,

"notifications" : [ {

"action" : "smtpmail -h mailhost -s \"Volume marked full\"

Administrators",

"events" : [ "Media" ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/notifications/Volume%2Bmarked%2Bfull",

"rel" : "item"

} ],

"name" : "Volume marked full",

"priorities" : [ "Alert" ],

"resourceId" : {

"id" : "27.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

}, {

"action" : "nsrlog -f \"C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\media.log\"",

"events" : [ "VolumeScanNeeded" ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/notifications/Volume%2Bscan%2Bneeded",

"rel" : "item"

} ],

"name" : "Volume scan needed",

"priorities" : [ "Emergency" ],

"resourceId" : {

"id" : "31.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 107

Dell Customer Communication - Confidential

200 Information about the notifications are retrieved successfully. NotificationList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /notifications

Creates a new notification. (postNotification)

This operation can be used to create a new notification. Notification serves as a means to attach an event of interest to a specific action, where the action can be a command or custom script to be run. For example, a notification can be configured to send email for a certain type of event.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

notification Notification (required) Body Parameter Notification to be created.

Example request body

Content-Type: application/json

{

"action": "smtpmail -h mailhost -s \"host :

Bus/Device reset detected\" Administrators",

"events": [

"BusDeviceReset"

],

"name": "Example Notification",

"priorities": [

"Alert",

"Warning"

]

}

NetWorker 9.1.x REST API Reference Guide. 108

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Notification is created successfully. The notification resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

402 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /notifications/{notificationId}

Updates the specific notification. (putNotification)

This operation can be used to update a specific notification. Notification serves as a means to attach an event of interest to a specific action, where the action can be a command or custom script to be run. For example, a notification may be updated to modify the associated priorities or the action.

Path parameters

notificationId (required) Path Parameter is the value of the name attribute in the notification resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

NetWorker 9.1.x REST API Reference Guide. 109

Dell Customer Communication - Confidential

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

notification Notification (required) Body Parameter Notification data for update.

Example request body

Content-Type: application/json

{

"action": "smtpmail -h mailhost -s \"host :

Bus/Device reset detected\" Administrators",

"events": [

"BusDeviceReset"

],

"name": "Bus/Device Reset",

"priorities": [

"Alert"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Notification is updated successfully. EmptyResponse

400 BadRequestErrorResponse

NetWorker 9.1.x REST API Reference Guide. 110

Dell Customer Communication - Confidential

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Pools

Up DELETE /pools/{poolId}

Deletes the specific media pool. (deletePool)

This operation can be used to delete a media pool from NetWorker. A media pool represents a collection of backups.

Path parameters

poolId (required) Path Parameter is the value of the name attribute in the pool resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Media pool is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

NetWorker 9.1.x REST API Reference Guide. 111

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /pools/{poolId}

Returns the specific media pool. (getPool)

This operation can fetch the information about the specific media pool. A media pool represents a collection of backups.

Path parameters

poolId (required) Path Parameter is the value of the name attribute in the pool resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Pool

Example data

Content-Type: application/json

{

"autoMediaVerify" : false,

"createDltWorm" : false,

"devices" : [ ],

"enabled" : true,

"labelTemplate" : "Archive",

"links" : [ ],

"maxParallelism" : 0,

"maxVolumesToRecycle" : 200,

"name" : "Archive",

"poolType" : "Archive",

"recycleFromOtherPools" : false,

"recycleInterval" : "24:00",

"recycleToOtherPools" : false,

"resourceId" : {

"id" : "106.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"storeIndexEntries" : false,

"wormPool" : false

}

Produces

NetWorker 9.1.x REST API Reference Guide. 112

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 The specified media pool is retrieved successfully. Pool

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /pools

Returns a list of media pools. (getPools)

This operation can be used to retrieve the information about all the media pools. However, the query parameters can be used to filter the response. A media pool represents a collection of backups.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

NetWorker 9.1.x REST API Reference Guide. 113

Dell Customer Communication - Confidential

PoolList

Example data

Content-Type: application/json

{

"count" : 2,

"pools" : [ {

"autoMediaVerify" : false,

"createDltWorm" : false,

"devices" : [ ],

"enabled" : true,

"labelTemplate" : "Archive",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/pools/Archive",

"rel" : "item"

} ],

"maxParallelism" : 0,

"maxVolumesToRecycle" : 200,

"name" : "Archive",

"poolType" : "Archive",

"recycleFromOtherPools" : false,

"recycleInterval" : "24:00",

"recycleToOtherPools" : false,

"resourceId" : {

"id" : "106.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"storeIndexEntries" : false,

"wormPool" : false

}, {

"autoMediaVerify" : false,

"createDltWorm" : false,

"devices" : [ ],

"enabled" : true,

"labelTemplate" : "Archive Clone",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/pools/Archive%2BClone",

"rel" : "item"

} ],

"maxParallelism" : 0,

"maxVolumesToRecycle" : 200,

"name" : "Archive Clone",

"poolType" : "ArchiveClone",

"recycleFromOtherPools" : false,

"recycleInterval" : "24:00",

"recycleToOtherPools" : false,

"resourceId" : {

"id" : "107.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

NetWorker 9.1.x REST API Reference Guide. 114

Dell Customer Communication - Confidential

"sequence" : 1

},

"storeIndexEntries" : false,

"wormPool" : false

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the media pools are retrieved successfully. PoolList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /pools

Creates a new media pool. (postPools)

This operation can be used to create a media pool. A media pool represents a collection of backups.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

pool Pool (required) Body Parameter Media pool to be created.

Example request body

NetWorker 9.1.x REST API Reference Guide. 115

Dell Customer Communication - Confidential

Content-Type: application/json

{

"autoMediaVerify": false,

"createDltWorm": false,

"enabled": true,

"labelTemplate": "Archive",

"maxParallelism": 0,

"maxVolumesToRecycle": 200,

"name": "Archive_new_name",

"poolType": "Archive",

"recycleFromOtherPools": false,

"recycleInterval": "24:00",

"recycleToOtherPools": false,

"storeIndexEntries": false,

"wormPool": false

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A new media pool is created successfully. The pool resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 116

Dell Customer Communication - Confidential

Up PUT /pools/{poolId}

Updates the specific media pool. (putPool)

This operation can be used to modify the attributes of a media pool. A media pool represents a collection of backups.

Path parameters

poolId (required) Path Parameter is the value of the name attribute in the pool resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

pool Pool (required) Body Parameter Media pool data for the update.

Example request body

Content-Type: application/json

{

"autoMediaVerify": false,

"createDltWorm": false,

"enabled": true,

"labelTemplate": "Archive",

"maxParallelism": 0,

"maxVolumesToRecycle": 200,

"name": "Archive",

"poolType": "Archive",

"recycleFromOtherPools": false,

"recycleInterval": "24:00",

"recycleToOtherPools": false,

"storeIndexEntries": false,

"wormPool": false

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 117

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Media pool is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Probes

Up DELETE /probes/{probeId}

Deletes the specific probe. (deleteProbe)

This operation can be used to delete the specific probe. The probe resource can be associated to a specific NetWorker client resource, so that probe is initiated against that NetWorker client before the backup begins. Further, the client should be assigned to the protection group that is tied with a workflow having a probe action.

Path parameters

probeId (required) Path Parameter is the value of the name attribute in the probe resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 118

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Probe is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /probes/{probeId}

Returns the specific probe. (getProbe)

This operation can be used to retrieve the information about the specific probe. The probe resource can be associated to a specific NetWorker client resource, so that probe is initiated against that NetWorker client before the backup begins. Further, the client should be assigned to the protection group that is tied with a workflow having a probe action.

Path parameters

probeId (required) Path Parameter is the value of the name attribute in the probe resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Probe

Example data

Content-Type: application/json

{

"commandOptions" : "host-restapi",

"comment" : "Probing nsrinfo",

"name" : "nsrinfo_probe",

NetWorker 9.1.x REST API Reference Guide. 119

Dell Customer Communication - Confidential

"probeCommand" : "nsrinfo",

"resourceId" : {

"id" : "193.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the probe is retrieved successfully. Probe

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /probes

Returns a list of probes. (getProbes)

This operation can be used to retrieve a list of probe resource instances. However, the query parameters can be used to filter the response. The probe resource can be associated to a specific NetWorker client resource, so that probe is initiated against that NetWorker client before the backup begins. The client must be assigned to the protection group that is associated with a workflow having a probe action.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter,

NetWorker 9.1.x REST API Reference Guide. 120

Dell Customer Communication - Confidential

for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

ProbeList

Example data

Content-Type: application/json

{

"count" : 1,

"probes" : [ {

"commandOptions" : "host-restapi",

"comment" : "Probing nsrinfo",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/probes/nsrinfo_probe",

"rel" : "item"

} ],

"name" : "nsrinfo_probe",

"probeCommand" : "nsrinfo",

"resourceId" : {

"id" : "193.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the probe resources are retrieved successfully. ProbeList

400

NetWorker 9.1.x REST API Reference Guide. 121

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /probes

Creates a new probe. (postProbes)

This operation can be used to create a probe. The probe resource can be associated to a specific NetWorker client resource, so that probe is initiated against that NetWorker client before the backup begins. Further, the client should be assigned to the protection group that is tied with a workflow having a probe action.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

probe Probe (required) Body Parameter Probe to be created.

Example request body

Content-Type: application/json

{

"commandOptions": "host-restapi",

"comment": "Probing nsrinfo",

"name": "nsrinfo_probe",

"probeCommand": "nsrinfo"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

NetWorker 9.1.x REST API Reference Guide. 122

Dell Customer Communication - Confidential

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Probe is created successfully. The probe resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /probes/{probeId}

Updates the specific probe. (putProbe)

This operation can be used to update the specific probe. The probe resource can be associated to a specific NetWorker client resource, so that probe is initiated against that NetWorker client before the backup begins. Further, the client should be assigned to the protection group that is tied with a workflow having a probe action.

Path parameters

probeId (required) Path Parameter is the value of the name attribute in the probe resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

NetWorker 9.1.x REST API Reference Guide. 123

Dell Customer Communication - Confidential

probe Probe (required) Body Parameter Probe data for the update.

Example request body

Content-Type: application/json

{

"commandOptions": "host-restapi2"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Probe is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Protectiongroups

Up DELETE /protectiongroups/{protectionGroupId}

Deletes the specific protection group. (deleteProtectionGroup)

NetWorker 9.1.x REST API Reference Guide. 124

Dell Customer Communication - Confidential

This operation can delete the specific protection group. The protection group is a collection of clients, save sets, or NAS device resources.

Path parameters

protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Protection group is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /protectiongroups/{protectionGroupId}

Returns the specific protection group. (getProtectionGroup)

This operation can fetch the information about the specific protection group. The protection group is a collection of clients, save sets, or NAS device resources.

Path parameters

protectionGroupId (required)

NetWorker 9.1.x REST API Reference Guide. 125

Dell Customer Communication - Confidential

Path Parameter is the value of the name attribute in the protection group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

ProtectionGroup

Example data

Content-Type: application/json

{

"comment" : "Default protection group for workflow

Bronze/ApplicationsExample",

"dynamicAssociation" : true,

"links" : [ ],

"name" : "Bronze-ApplicationExample",

"resourceId" : {

"id" : "188.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"workItemExclusions" : [ ],

"workItemQueries" : [ ],

"workItemSource" : "Static",

"workItemSubType" : "None",

"workItemType" : "Client",

"workItems" : [ ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific protection group is retrieved successfully. ProtectionGroup

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 126

Dell Customer Communication - Confidential

Up GET /protectiongroups

Returns a list of protection groups. (getProtectionGroups)

This operation can be used to retrieve the information about all the protection groups. However, the query parameters can be used to filter the response. The protection group is a collection of clients, save sets, or NAS device resources.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

ProtectionGroupList

Example data

Content-Type: application/json

{

"count" : 2,

"protectionGroups" : [ {

"comment" : "Default protection group for workflow

Bronze/Applications",

"dynamicAssociation" : true,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectiongroups/Bronze-Application",

"rel" : "item"

} ],

"name" : "Bronze-Application",

"resourceId" : {

"id" : "150.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

NetWorker 9.1.x REST API Reference Guide. 127

Dell Customer Communication - Confidential

"sequence" : 1

},

"workItemExclusions" : [ ],

"workItemQueries" : [ ],

"workItemSource" : "Static",

"workItemSubType" : "None",

"workItemType" : "Client",

"workItems" : [ ]

}, {

"comment" : "Default protection group for workflow

Bronze/ApplicationsExample",

"dynamicAssociation" : true,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectiongroups/Bronze-

ApplicationExample",

"rel" : "item"

} ],

"name" : "Bronze-ApplicationExample",

"resourceId" : {

"id" : "188.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"workItemExclusions" : [ ],

"workItemQueries" : [ ],

"workItemSource" : "Static",

"workItemSubType" : "None",

"workItemType" : "Client",

"workItems" : [ ]

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the protection groups are retrieved successfully. ProtectionGroupList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404

NetWorker 9.1.x REST API Reference Guide. 128

Dell Customer Communication - Confidential

NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /protectiongroups

Creates a new protection group. (postProtectionGroups)

This operation can be used to create a new protection group. The protection group is a collection of clients, save sets, or NAS device resources. This end point is used to create a new protection group.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

protectiongroups ProtectionGroup (required) Body Parameter Protection group to be created.

Example request body

Content-Type: application/json

{

"comment": "Default protection group for workflow

Bronze/ApplicationsExample",

"dynamicAssociation": true,

"name": "Bronze-ApplicationExample",

"workItemSource": "Static",

"workItemSubType": "None",

"workItemType": "Client"

}

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 129

Dell Customer Communication - Confidential

application/json

Responses

201 Protection group is created successfully. The protection group resource URI can be found in the location header of the response.

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /protectiongroups/{protectionGroupId}

Updates the specific protection group. (putProtectionGroups)

This operation can update the information about the specific protection group. The protection group is a collection of clients, save sets, or NAS device resources.

Path parameters

protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

protectionGroup ProtectionGroup (required) Body Parameter Protection group data for the update.

Example request body

Content-Type: application/json

{

"comment": "Default protection group for workflow

Bronze/ApplicationsExample",

"dynamicAssociation": false

}

NetWorker 9.1.x REST API Reference Guide. 130

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Protection group is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /protectiongroups/{protectionGroupId}/op/updatevmwareworkitems

Updates the work items for VMware/all protection groups. (updateVMwareWorkItems)

Updates the work items for VMware/all protection groups.

Path parameters

protectionGroupId (required) Path Parameter is the value of the name attribute in the protection group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

NetWorker 9.1.x REST API Reference Guide. 131

Dell Customer Communication - Confidential

application/json

Request body

VMwareWorkItemOpUpdate VMwareWorkItemOpUpdate (required) Body Parameter Parameters to update the VMware work items.

Example request body

Content-Type: application/json

{

"addWorkItems": {

"vCenterHostname": "10.118.244.149",

"containerMorefs": [

"vm-204"

],

"vmUuids": [

"502318d2-800e-6b10-27f0-ad146181c3a1"

],

"vmdks": [

{

"vmUuid": "3377e0e2-00000006-fc979bd8-5b979bd8-

00055000-45093256",

"vmdkUuid": "c45dcfaf-8583-4040-9547-

898edc6d3c08"

}

]

}

}

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Updated successfully. EmptyResponse

400 BadRequestErrorResponse

NetWorker 9.1.x REST API Reference Guide. 132

Dell Customer Communication - Confidential

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Protectionpolicies

Up DELETE /protectionpolicies/{policyId}

Deletes the specific policy. (deletePolicy)

This operation can be used to delete the specific policy. The Protection Policy resource describes one or more workflows. Each workflow contains a sequence of actions that NetWorker uses to protect the data.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Protection policy is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

NetWorker 9.1.x REST API Reference Guide. 133

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up DELETE /protectionpolicies/{policyId}/workflows/{workflowId}

Deletes the specific workflow. (deletePolicyWorkflow)

This operation can be used to delete the specific workflow.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

workflowId (required) Path Parameter is the value of the name attribute in the workflow resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Workflow is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 134

Dell Customer Communication - Confidential

Up GET /protectionpolicies

Returns a list of policies. (getPolicies)

This operation can be used to retrieve the information on all the policies. However, the query parameters can be used to filter the response. The Protection Policy resource describes one or more workflows. Each workflow contains a set of actions and list of data sources to run those actions against.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

PolicyList

Example data

Content-Type: application/json

{

"count" : 2,

"protectionPolicies" : [ {

"comment" : "Template policy: Bronze",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/Bronze",

"rel" : "item"

} ],

"name" : "Bronze",

"resourceId" : {

"id" : "151.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 13

},

NetWorker 9.1.x REST API Reference Guide. 135

Dell Customer Communication - Confidential

"summaryNotification" : {

"command" : "nsrlog -f policy_notifications.log",

"executeOn" : "Completion"

},

"workflows" : [ {

"actions" : [ {

"actionSpecificData" : {

"backup" : {

"backupSpecificData" : {

"traditional" : {

"forceBackupLevel" : "",

"fileInactivityAlertThresholdPercentage" : 0,

"revertToFullWhenSyntheticFullFails" : true,

"destinationPool" : "Default",

"timestampFormat" : "None",

"verifySyntheticFull" : true,

"fileInactivityThresholdInDays" : 0,

"estimate" : false

}

},

"destinationStorageNodes" : [ "nsrserverhost" ],

"retentionPeriod" : "1 Months",

"clientOverride" : "ClientCanOverride",

"overrideBackupSchedule" : false,

"successThreshold" : "Success",

"overrideRetentionPeriod" : false

}

},

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"concurrent" : false,

"drivenBy" : "",

"enabled" : true,

"failureImpact" : "Continue",

"hardLimit" : "00:00",

"inactivityTimeoutInMin" : 30,

"name" : "Backup",

"parallelism" : 100,

"retries" : 1,

"retryDelayInSec" : 30,

"scheduleActivities" : [ "full", "incr", "incr", "incr",

"incr", "incr", "incr" ],

"schedulePeriod" : "Week",

"softLimit" : "00:00"

} ],

"autoStartEnabled" : false,

"completionNotification" : {

"command" : "",

NetWorker 9.1.x REST API Reference Guide. 136

Dell Customer Communication - Confidential

"executeOn" : "Ignore"

},

"description" : "Traditional Backup to pool Default, with

expiration 1 Months;",

"enabled" : true,

"endTime" : "21:00",

"name" : "Filesystem",

"protectionGroups" : [ "Bronze-Filesystem" ],

"restartTimeWindow" : "12:00",

"startInterval" : "24:00",

"startTime" : "21:00"

}, {

"actions" : [ {

"actionSpecificData" : {

"backup" : {

"backupSpecificData" : {

"traditional" : {

"forceBackupLevel" : "",

"fileInactivityAlertThresholdPercentage" : 0,

"revertToFullWhenSyntheticFullFails" : true,

"destinationPool" : "Default",

"timestampFormat" : "None",

"verifySyntheticFull" : true,

"fileInactivityThresholdInDays" : 0,

"estimate" : false

}

},

"destinationStorageNodes" : [ "nsrserverhost" ],

"retentionPeriod" : "1 Months",

"clientOverride" : "ClientCanOverride",

"overrideBackupSchedule" : false,

"successThreshold" : "Success",

"overrideRetentionPeriod" : false

}

},

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"concurrent" : false,

"drivenBy" : "",

"enabled" : true,

"failureImpact" : "Continue",

"hardLimit" : "00:00",

"inactivityTimeoutInMin" : 30,

"name" : "Backup",

"parallelism" : 100,

"retries" : 1,

"retryDelayInSec" : 30,

NetWorker 9.1.x REST API Reference Guide. 137

Dell Customer Communication - Confidential

"scheduleActivities" : [ "full", "incr", "incr", "incr",

"incr", "incr", "incr" ],

"schedulePeriod" : "Week",

"softLimit" : "00:00"

} ],

"autoStartEnabled" : false,

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"description" : "Traditional Backup to pool Default, with

expiration 1 Months;",

"enabled" : true,

"endTime" : "21:30",

"name" : "Applications",

"protectionGroups" : [ "Bronze-Application" ],

"restartTimeWindow" : "12:00",

"startInterval" : "24:00",

"startTime" : "21:30"

} ]

}, {

"comment" : "Template policy: Bronze for example",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/BronzeExample",

"rel" : "item"

} ],

"name" : "BronzeExample",

"resourceId" : {

"id" : "187.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"summaryNotification" : {

"command" : "nsrlog -f policy_notifications.log",

"executeOn" : "Completion"

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

NetWorker 9.1.x REST API Reference Guide. 138

Dell Customer Communication - Confidential

Information about the protection policies are retrieved successfully. PolicyList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /protectionpolicies/{policyId}

Returns the specific policy. (getPolicy)

This operation can fetch the information about the specific policy. The Protection Policy resource describes one or more workflows. Each workflow contains a sequence of actions that NetWorker uses to protect the data.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Policy

Example data

Content-Type: application/json

{

"comment" : "Template policy: Bronze for Example",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/BronzeExample/workflow

s",

"title" : "List of policy workflows"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/BronzeExample/jobgroup

s",

"title" : "List of job groups"

} ],

"name" : "BronzeExample",

"resourceId" : {

"id" : "187.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

NetWorker 9.1.x REST API Reference Guide. 139

Dell Customer Communication - Confidential

},

"summaryNotification" : {

"command" : "nsrlog -f policy_notifications.log",

"executeOn" : "Completion"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the policy is retrieved successfully. Policy

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /protectionpolicies/{policyId}/jobgroups/{jobGroupId}

Returns a list of jobs for a given job group. (getPolicyJobGroup)

This operation can be used to retrieve the information about a list of jobs for a given job group.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

jobGroupId (required) Path Parameter is the value of the id attribute in the job group resource.

Return type

JobList

Example data

NetWorker 9.1.x REST API Reference Guide. 140

Dell Customer Communication - Confidential

Content-Type: application/json

{

"count" : 2,

"jobs" : [ {

"adhocJob" : false,

"clientHostname" : "Winhost",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T05:21:27-04:00",

"exitCode" : 1,

"id" : 134,

"itemIdLong" : 134,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/134",

"rel" : "item"

} ],

"name" : "vm:50078e19-7fe5-b720-ca02-2ad6eace55e8:10.207.86.28",

"ndmp" : false,

"parentJobId" : 130,

"previousJobId" : 0,

"rootParentJobId" : 129,

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T05:20:46-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "save job"

}, {

"adhocJob" : false,

"clientHostname" : "Winhost2",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T05:21:27-04:00",

"exitCode" : 1,

"id" : 133,

"itemIdLong" : 133,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/133",

"rel" : "item"

} ],

"name" : "vm:500cc729-94fc-ea3a-cbd4-4b99e9c55d64:10.207.86.28",

"ndmp" : false,

"parentJobId" : 130,

"previousJobId" : 0,

"rootParentJobId" : 129,

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T05:20:46-04:00",

"state" : "Completed",

NetWorker 9.1.x REST API Reference Guide. 141

Dell Customer Communication - Confidential

"stopped" : true,

"tenant" : "",

"type" : "save job"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the job group is retrieved successfully. JobList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /protectionpolicies/{policyId}/jobgroups

Returns a list of job groups for a given policy. (getPolicyJobGroups)

This operation can be used to retrieve the information about a list of job groups for a given policy. However, the query parameters can be used to filter the response.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter,

NetWorker 9.1.x REST API Reference Guide. 142

Dell Customer Communication - Confidential

for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

JobList

Example data

Content-Type: application/json

{

"count" : 2,

"jobs" : [ {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -s host_name_1 -p vmware

-w vm_wf -L",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T21:00:01-04:00",

"exitCode" : 1,

"id" : 324,

"itemIdLong" : 324,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/vmware/jobgroups/324",

"rel" : "item"

} ],

"logFile" : "C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\workflow_vm_wf_000324.raw",

"message" : "133550 1540342801 1 0 0 16976 18020 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 6 vmware 0 5 vm_wf\n123316 1540342801 1 0

0 16976 18020 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 75

nsrvproxy_save -s host_name_1 -j 324 -L incr -p vmware -w vm_wf -A

backup\n123321 1540342801 1 0 0 16976 18020 0 host_name_1 nsrworkflow

NSR notice 39 Action '%s/%s/%s's log will be in '%s'. 4 0 6 vmware 0

5 vm_wf 0 6 backup 23 77 C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\vm_wf\\backup_000327.raw\n12332

5 1540342801 1 0 0 16976 18020 0 host_name_1 nsrworkflow NSR notice

21 Action '%s/%s/%s' %s. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 6

failed\n133555 1540342801 1 0 0 16976 18020 0 host_name_1 nsrworkflow

NSR notice 24 Workflow '%s/%s' failed. 2 0 6 vmware 0 5 vm_wf\n",

NetWorker 9.1.x REST API Reference Guide. 143

Dell Customer Communication - Confidential

"name" : "vmware",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/0/1",

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T21:00:01-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

"workflowName" : "vm_wf"

}, {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -s host_name_1 -p vmware

-w vm_wf -L",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T05:21:27-04:00",

"exitCode" : 1,

"id" : 129,

"itemIdLong" : 129,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/vmware/jobgroups/129",

"rel" : "item"

} ],

"logFile" : "C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\workflow_vm_wf_000129.raw",

"message" : "133550 1540286431 1 0 0 15568 17320 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 6 vmware 0 5 vm_wf\n123316 1540286431 1 0

0 15568 17320 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 75

nsrvproxy_save -s host_name_1 -j 129 -L incr -p vmware -w vm_wf -A

backup\n123321 1540286431 1 0 0 15568 17320 0 host_name_1 nsrworkflow

NSR notice 39 Action '%s/%s/%s's log will be in '%s'. 4 0 6 vmware 0

5 vm_wf 0 6 backup 23 77 C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\vm_wf\\backup_000130.raw\n12332

5 1540286487 1 0 0 15568 17320 0 host_name_1 nsrworkflow NSR notice

21 Action '%s/%s/%s' %s. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 6

failed\n133555 1540286487 1 0 0 15568 17320 0 host_name_1 nsrworkflow

NSR notice 24 Workflow '%s/%s' failed. 2 0 6 vmware 0 5 vm_wf\n",

"name" : "vmware",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/0/1",

"rootParentJobId" : 0,

NetWorker 9.1.x REST API Reference Guide. 144

Dell Customer Communication - Confidential

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T05:20:31-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

"workflowName" : "vm_wf"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the job groups are retrieved successfully. JobList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /protectionpolicies/{policyId}/workflows/{workflowId}

Returns the specific workflow. (getPolicyWorkflow)

This operation can be used to retrieve the information about the specific workflow associated with a policy.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

workflowId (required) Path Parameter is the value of the name attribute in the workflow resource.

NetWorker 9.1.x REST API Reference Guide. 145

Dell Customer Communication - Confidential

Return type

PolicyWorkflow

Example data

Content-Type: application/json

{

"autoStartEnabled" : true,

"comment" : "Template policy: Bronze for Example",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"description" : "Empty workflow;",

"enabled" : true,

"endTime" : "21:00",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/Bronze/workflows/Bronz

eExample/op/backup",

"title" : "Run policy workflow"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/Bronze/workflows/Bronz

eExample/jobgroups",

"title" : "List of job groups"

} ],

"name" : "BronzeExample",

"nextStartDate" : "2018-10-24T21:00:00-04:00",

"restartTimeWindow" : "12:00",

"startInterval" : "24:00",

"startTime" : "21:00"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the workflow is retrieved successfully. PolicyWorkflow

400 BadRequestErrorResponse

401 AuthNErrorResponse

NetWorker 9.1.x REST API Reference Guide. 146

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET

/protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups/{jobG

roupId}

Returns a list of jobs for a given job group. (getPolicyWorkflowJobGroup)

This operation can be used to retrieve a list of jobs for a given job group.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

workflowId (required) Path Parameter is the value of the name attribute in the workflow resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

jobGroupId (required) Path Parameter is the value of the id attribute in the job group resource.

Return type

JobList

Example data

Content-Type: application/json

{

"count" : 2,

"jobs" : [ {

"adhocJob" : false,

"clientHostname" : "Winhost",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T05:21:27-04:00",

"exitCode" : 1,

"id" : 134,

"itemIdLong" : 134,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/134",

"rel" : "item"

} ],

"name" : "vm:50078e19-7fe5-b720-ca02-2ad6eace55e8:10.207.86.28",

NetWorker 9.1.x REST API Reference Guide. 147

Dell Customer Communication - Confidential

"ndmp" : false,

"parentJobId" : 130,

"previousJobId" : 0,

"rootParentJobId" : 129,

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T05:20:46-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "save job"

}, {

"adhocJob" : false,

"clientHostname" : "Winhost2",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T05:21:27-04:00",

"exitCode" : 1,

"id" : 133,

"itemIdLong" : 133,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/133",

"rel" : "item"

} ],

"name" : "vm:500cc729-94fc-ea3a-cbd4-4b99e9c55d64:10.207.86.28",

"ndmp" : false,

"parentJobId" : 130,

"previousJobId" : 0,

"rootParentJobId" : 129,

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T05:20:46-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "save job"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the job group is retrieved successfully. JobList

NetWorker 9.1.x REST API Reference Guide. 148

Dell Customer Communication - Confidential

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /protectionpolicies/{policyId}/workflows/{workflowId}/jobgroups

Returns a list of job groups for a given workflow. (getPolicyWorkflowJobGroups)

This operation can be used to retrieve a list of job groups for a given workflow. However, the query parameters can be used to filter the response.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

workflowId (required) Path Parameter is the value of the name attribute in the workflow resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

NetWorker 9.1.x REST API Reference Guide. 149

Dell Customer Communication - Confidential

JobList

Example data

Content-Type: application/json

{

"count" : 2,

"jobs" : [ {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -s host_name_1 -p vmware

-w vm_wf -L",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T21:00:01-04:00",

"exitCode" : 1,

"id" : 324,

"itemIdLong" : 324,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/vmware/jobgroups/324",

"rel" : "item"

} ],

"logFile" : "C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\workflow_vm_wf_000324.raw",

"message" : "133550 1540342801 1 0 0 16976 18020 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 6 vmware 0 5 vm_wf\n123316 1540342801 1 0

0 16976 18020 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 75

nsrvproxy_save -s host_name_1 -j 324 -L incr -p vmware -w vm_wf -A

backup\n123321 1540342801 1 0 0 16976 18020 0 host_name_1 nsrworkflow

NSR notice 39 Action '%s/%s/%s's log will be in '%s'. 4 0 6 vmware 0

5 vm_wf 0 6 backup 23 77 C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\vm_wf\\backup_000327.raw\n12332

5 1540342801 1 0 0 16976 18020 0 host_name_1 nsrworkflow NSR notice

21 Action '%s/%s/%s' %s. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 6

failed\n133555 1540342801 1 0 0 16976 18020 0 host_name_1 nsrworkflow

NSR notice 24 Workflow '%s/%s' failed. 2 0 6 vmware 0 5 vm_wf\n",

"name" : "vmware",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/0/1",

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T21:00:01-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

NetWorker 9.1.x REST API Reference Guide. 150

Dell Customer Communication - Confidential

"workflowName" : "vm_wf"

}, {

"adhocJob" : false,

"command" : "\"C:\\\\Program Files\\\\EMC

NetWorker\\\\nsr\\\\bin\\\\nsrworkflow.exe\" -s host_name_1 -p vmware

-w vm_wf -L",

"completionStatus" : "Failed",

"dependentJobIds" : [ 0 ],

"endTime" : "2018-10-23T05:21:27-04:00",

"exitCode" : 1,

"id" : 129,

"itemIdLong" : 129,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/vmware/jobgroups/129",

"rel" : "item"

} ],

"logFile" : "C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\workflow_vm_wf_000129.raw",

"message" : "133550 1540286431 1 0 0 15568 17320 0 host_name_1

nsrworkflow NSR notice 31 Starting %s '%s' workflow '%s'. 3 11 24

127405:Protection Policy 0 6 vmware 0 5 vm_wf\n123316 1540286431 1 0

0 15568 17320 0 host_name_1 nsrworkflow NSR notice 46 Starting action

'%s/%s/%s' with command: '%s'. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 75

nsrvproxy_save -s host_name_1 -j 129 -L incr -p vmware -w vm_wf -A

backup\n123321 1540286431 1 0 0 15568 17320 0 host_name_1 nsrworkflow

NSR notice 39 Action '%s/%s/%s's log will be in '%s'. 4 0 6 vmware 0

5 vm_wf 0 6 backup 23 77 C:\\Program Files\\EMC

NetWorker\\nsr\\logs\\policy\\vmware\\vm_wf\\backup_000130.raw\n12332

5 1540286487 1 0 0 15568 17320 0 host_name_1 nsrworkflow NSR notice

21 Action '%s/%s/%s' %s. 4 0 6 vmware 0 5 vm_wf 0 6 backup 0 6

failed\n133555 1540286487 1 0 0 15568 17320 0 host_name_1 nsrworkflow

NSR notice 24 Workflow '%s/%s' failed. 2 0 6 vmware 0 5 vm_wf\n",

"name" : "vmware",

"ndmp" : false,

"parentJobId" : 0,

"previousJobId" : 0,

"progress" : "1/0/1",

"rootParentJobId" : 0,

"runOnHost" : "host_name_1",

"siblingJobIds" : [ ],

"startTime" : "2018-10-23T05:20:31-04:00",

"state" : "Completed",

"stopped" : true,

"tenant" : "",

"type" : "workflow job",

"workflowName" : "vm_wf"

} ]

}

Produces

NetWorker 9.1.x REST API Reference Guide. 151

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the job groups are retrieved successfully. JobList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /protectionpolicies

Creates a new policy. (postPolicy)

This operation can be used create a new policy. The Protection Policy resource describes one or more workflows. Each workflow contains a sequence of actions that NetWorker uses to protect the data.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

policy Policy (required) Body Parameter Policy to be created.

Example request body

Content-Type: application/json

{

"comment": "Template policy: Bronze for Example",

"name": "BronzeExample"

}

NetWorker 9.1.x REST API Reference Guide. 152

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Policy is created successfully. The policy resource URI can be found in the location header of the response.

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /protectionpolicies/{policyId}/workflows

Creates a new workflow. (postPolicyWorkflow)

This operation can be used to create a workflow. Each policy has one or more workflows. A workflow enables you to chain together multiple actions and a list of data sources to run those actions.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

workflow PolicyWorkflow (required) Body Parameter Workflow to be created.

Example request body

NetWorker 9.1.x REST API Reference Guide. 153

Dell Customer Communication - Confidential

Content-Type: application/json

{

"autoStartEnabled": false,

"description": "Traditional Backup to pool Default, with

expiration 1 Months;",

"name": "FilesystemExample",

"protectionGroups": [

"Bronze-ApplicationExample"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Workflow is created successfully. The workflow resource URI can be found in the location header of the response.

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /protectionpolicies/{policyId}/workflows/{workflowId}/op/backup

Starts the specified workflow. (postPolicyWorkflowOpBackup)

This operation can be used to start a workflow. You can optionally customize the client list and also specify the action overrides.

Path parameters

policyId (required)

NetWorker 9.1.x REST API Reference Guide. 154

Dell Customer Communication - Confidential

Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

workflowId (required) Path Parameter is the value of the name attribute in the workflow resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

policyWorkflowOpBackup PolicyWorkflowOpBackup (required) Body Parameter Parameters to start the workflow.

Example request body

Content-Type: application/json

{

"actionOverrides":[

{

"action":"clone",

"commandLineArguments":"-y 3 years"

}

],

"restart":true

}

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A job is created. The job URI can be found in the location header of the response.

400 BadRequestErrorResponse

401 AuthNErrorResponse

NetWorker 9.1.x REST API Reference Guide. 155

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /protectionpolicies/{policyId}

Updates the specific policy. (putPolicy)

This operation can be used to update the specific policy. The Protection Policy resource describes one or more workflows. Each workflow contains a sequence of actions that NetWorker uses to protect the data.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

policy Policy (required) Body Parameter Policy data for update.

Example request body

Content-Type: application/json

{

"comment": "Template policy: Bronze for example is

updated"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

NetWorker 9.1.x REST API Reference Guide. 156

Dell Customer Communication - Confidential

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Protection policy is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /protectionpolicies/{policyId}/workflows/{workflowId}

Updates the specific workflow. (putPolicyWorkflow)

This operation can be used to update the specific workflow.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

workflowId (required) Path Parameter is the value of the name attribute in the workflow resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

workflow PolicyWorkflow (required) Body Parameter Workflow data for update.

Example request body

Content-Type: application/json

NetWorker 9.1.x REST API Reference Guide. 157

Dell Customer Communication - Confidential

{

"comment":"Updating workflow with Action and Protection Group

",

"actions":[

{

"actionSpecificData":{

"backup":{

"destinationStorageNodes":[

"nsrserverhost"

],

"backupSpecificData":{

"traditional":{

"destinationPool":"Default"

}

}

}

},

"name":"backup",

"comment":"",

"completionNotification":{

"command":"",

"executeOn":"Ignore"

}

}

],

"autoStartEnabled":true,

"protectionGroups":[

"test"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 158

Dell Customer Communication - Confidential

204 Workflow is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Recovers

Up DELETE /recovers/{recoverId}

Deletes the specific recover resource. (deleteRecover)

This operation can be used to delete a specific recover resource.

Path parameters

recoverId (required) Path Parameter is the value of the id attribute of the recover resource's resourceId.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Recover resource is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403

NetWorker 9.1.x REST API Reference Guide. 159

Dell Customer Communication - Confidential

AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /recovers/{recoverId}

Returns the specific recover resource. (getRecover)

This operation can be used to retrieve the information about the specific recovery resource.

Path parameters

recoverId (required) Path Parameter is the value of the id attribute of the recover resource's resourceId.

Return type

Recover

Example data

Content-Type: application/json

{

"destinationClientResID" : "c9797b4d-00000004-59e73721-59e8490b-

000c5000-a6138c56",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/jobs/800142",

"rel" : "item"

} ],

"name" : "NDMP_8817_189862517965772",

"recoveryDestination" : "/ifs/data",

"recoveryStartTime" : "2017-11-23T01:50:51-08:00",

"recoveryType" : "NDMP",

"sourceClient" : "ISILON",

"backupInstance" : {

"backupID" : "855e9b15-00000006-f9b7fe7b-59b7fe7b-00085000-

bde5b856",

"instanceID" : "1506346646"

},

"resourceId" : {

"id" : "49.0.96.18.0.0.0.0.47.81.22.90.10.207.86.34",

"sequence" : 1

}

}

NetWorker 9.1.x REST API Reference Guide. 160

Dell Customer Communication - Confidential

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the recovery resource is retrieved successfully. Recover

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /recovers

Returns a list of all recover resources. This doesn't include recover resources associated with the application recovery. (getRecovers)

This operation can be used to retrieve a list of all recover resources. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

NetWorker 9.1.x REST API Reference Guide. 161

Dell Customer Communication - Confidential

Return type

RecoverList

Example data

Content-Type: application/json

{

"count" : 1,

"recovers" : [ {

"destinationClientResID" : "c9797b4d-00000004-59e73721-59e8490b-

000c5000-a6138c56",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/recovers/49.0.96.18.0.0.0.0.47.81.22.90.1

0.207.86.34",

"rel" : "item"

} ],

"name" : "NDMP_8817_189862517965772",

"recoveryDestination" : "/ifs/data",

"recoveryStartTime" : "2017-11-23T01:50:51-08:00",

"recoveryType" : "NDMP",

"sourceClient" : "ISILON",

"backupInstance" : {

"backupID" : "855e9b15-00000006-f9b7fe7b-59b7fe7b-00085000-

bde5b856",

"instanceID" : "1506346646"

},

"resourceId" : {

"id" : "49.0.96.18.0.0.0.0.47.81.22.90.10.207.86.34",

"sequence" : 1

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Recovery resources are retrieved successfully. RecoverList

400 BadRequestErrorResponse

401 AuthNErrorResponse

NetWorker 9.1.x REST API Reference Guide. 162

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /recovers

Creates a new recover resource. (postRecover)

This operation can be used to create a new recover resource to initiate a recovery operation.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

recover Recover (required) Body Parameter Recover resource to be created.

Example request body

Content-Type: application/json

{

"recoveryType": "NDMP",

"recoveryDestination": "/ifs/data",

"backupInstance": {

"backupID": "855e9b15-00000006-f9b7fe7b-59b7fe7b-

0008500-bde5b856",

"instanceID": "1506346646"

}

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 163

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Recover resource is created successfully. The recover resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Protectionpolicies

Up GET /protectionpolicies/{policyId}/workflows

Returns a list of workflows for a policy. (getPolicyWorkflows)

This operation can be used to retrieve the information about all the workflows associated with the policy. However, the query parameters can be used to filter the response.

Path parameters

policyId (required) Path Parameter is the value of the name attribute in the protection policy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

NetWorker 9.1.x REST API Reference Guide. 164

Dell Customer Communication - Confidential

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

PolicyWorkflowList

Example data

Content-Type: application/json

{

"count" : 2,

"workflows" : [ {

"autoStartEnabled" : true,

"comment" : "Template policy: Bronze for Example",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"description" : "Empty workflow;",

"enabled" : true,

"endTime" : "21:00",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/Bronze/workflows/Bronz

eExample",

"rel" : "item"

} ],

"name" : "BronzeExample",

"nextStartDate" : "2018-10-24T21:00:00-04:00",

"restartTimeWindow" : "12:00",

"startInterval" : "24:00",

"startTime" : "21:00"

}, {

"autoStartEnabled" : false,

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"description" : "Empty workflow;",

"enabled" : true,

"endTime" : "21:00",

"links" : [ {

NetWorker 9.1.x REST API Reference Guide. 165

Dell Customer Communication - Confidential

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/protectionpolicies/Bronze/workflows/Files

ystemExample",

"rel" : "item"

} ],

"name" : "FilesystemExample",

"protectionGroups" : [ "Bronze-ApplicationExample" ],

"restartTimeWindow" : "12:00",

"startInterval" : "24:00",

"startTime" : "21:00"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the workflow are retrieved successfully. PolicyWorkflowList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Rules

Up DELETE /rules/{ruleName}

Deletes the specific rule. (deleteRule)

This operation can be used to delete the specific rule. A rule serves as the means to define conditions to process an action in a protection group.

Path parameters

ruleName (required)

NetWorker 9.1.x REST API Reference Guide. 166

Dell Customer Communication - Confidential

Path Parameter is the value of the name attribute in the rule resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Rule is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /rules/{ruleName}

Returns the information about the specific rule. (getRule)

This operation can be used to get the information about the specific rule. A rule serves as the means to define conditions to process an action in a protection group.

Path parameters

ruleName (required) Path Parameter is the value of the name attribute in the rule resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Rule

NetWorker 9.1.x REST API Reference Guide. 167

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"comment" : "From REST API",

"dataSourceType" : "VMware",

"definitions" : [ {

"operator" : "Equals",

"property" : "Name",

"type" : "VirtualMachine",

"value" : "vm"

} ],

"name" : "new2",

"resourceId" : {

"id" : "43.0.136.16.0.0.0.0.127.78.121.90.10.31.227.175",

"sequence" : 1

},

"ruleMatchType" : "Any"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the rule is retrieved successfully. Rule

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /rules

Returns a list of rules. (getRules)

This operation can be used to retrieve a list of rules. However, the query parameters can be used to filter the response.

NetWorker 9.1.x REST API Reference Guide. 168

Dell Customer Communication - Confidential

A rule serves as the means to define conditions to process an action in a protection group.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

RuleList

Example data

Content-Type: application/json

{

"count" : 2,

"rules" : [ {

"comment" : "From REST API",

"dataSourceType" : "VMware",

"definitions" : [ {

"operator" : "Equals",

"property" : "Name",

"type" : "VirtualMachine",

"value" : "vm"

} ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/rules/new2",

"rel" : "item"

} ],

"name" : "new2",

"resourceId" : {

"id" : "43.0.136.16.0.0.0.0.127.78.121.90.example.com",

"sequence" : 1

},

NetWorker 9.1.x REST API Reference Guide. 169

Dell Customer Communication - Confidential

"ruleMatchType" : "Any"

}, {

"comment" : "",

"dataSourceType" : "VMware",

"definitions" : [ {

"operator" : "Equals",

"property" : "Name",

"type" : "VirtualMachine",

"value" : "vm"

} ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/rules/new1",

"rel" : "item"

} ],

"name" : "new1",

"resourceId" : {

"id" : "43.0.64.14.0.0.0.0.244.74.121.90.example.com",

"sequence" : 1

},

"ruleMatchType" : "All"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the rule is retrieved successfully. RuleList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /rules

Creates a new rule. (postRules)

NetWorker 9.1.x REST API Reference Guide. 170

Dell Customer Communication - Confidential

This operation can be used to creates a new rule. A rule serves as the means to define conditions to process an action in a protection group.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

rule Rule (required) Body Parameter Rule to be created.

Example request body

Content-Type: application/json

{

"dataSourceType": "VMware",

"definitions": [

{

"operator": "Contains",

"property": "Name",

"type": "VirtualMachine",

"value": "rehl"

}

],

"matchType": "All",

"name": "Example_rule"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

NetWorker 9.1.x REST API Reference Guide. 171

Dell Customer Communication - Confidential

Responses

201 Rule is created successfully. The rule resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /rules/{ruleName}

Updates the specific rule. (putRule)

This operation can be used to modify a specific rule.

Path parameters

ruleName (required) Path Parameter is the value of the name attribute in the rule resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

rule Rule (required) Body Parameter Rule data for the update.

Example request body

Content-Type: application/json

{

"dataSourceType": "VMware",

"definitions": [

{

"operator": "Contains",

"property": "Name",

"type": "VirtualMachine",

"value": "rehl"

}

],

"matchType": "All",

"name": "Example_rule"

}

NetWorker 9.1.x REST API Reference Guide. 172

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Rule is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Schedules

Up DELETE /schedules/{scheduleName}

Deletes the specific schedule resource. (deleteSchedule)

This operation can be used to delete a specific schedule from NetWorker.

Path parameters

scheduleName (required) Path Parameter is the value of the name attribute in the schedule object.

Return type

EmptyResponse

NetWorker 9.1.x REST API Reference Guide. 173

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Schedule is deleted successfully from NetWorker. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500

Up GET /schedules/{scheduleName}/associatedpolicies

Returns the associated policies. (getAssociatedPolicies)

This operation can fetch the policy, workflow and action associated with a schedule.

Path parameters

scheduleName (required) Path Parameter is the value of the name attribute in the schedule object.

Return type

AssociatedPolicyList

Example data

Content-Type: application/json

{

"associations" : [ {

"action" : "Test",

"policy" : "KIRAN",

NetWorker 9.1.x REST API Reference Guide. 174

Dell Customer Communication - Confidential

"workflow" : "TEST"

}, {

"action" : "Test",

"policy" : "KIRAN1",

"workflow" : "TEST"

}, {

"action" : "Test",

"policy" : "KIRAN2",

"workflow" : "TEST"

} ],

"count" : 3

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Resource is retrieved successfully. AssociatedPolicyList

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500

Up GET /schedules/{scheduleName}

Returns the specific schedule. (getSchedule)

This operation can fetch the information about the specific schedule.

Path parameters

scheduleName (required) Path Parameter is the value of the name attribute in the schedule object.

Return type

Schedule

NetWorker 9.1.x REST API Reference Guide. 175

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"levels" : [ "full", "incr", "incr", "incr", "incr", "incr",

"incr", "full", "incr", "incr", "incr", "incr", "incr", "incr",

"full", "incr", "incr", "incr", "incr", "incr", "incr", "full",

"incr", "incr", "incr", "incr", "incr", "incr", "full", "incr",

"incr" ],

"links" : [ ],

"name" : "test",

"overrides" : [ {

"date" : "1/2/2019",

"level" : "incr"

}, {

"date" : "1/2/2019",

"level" : "full"

} ],

"period" : "Month",

"resourceId" : {

"id" : "45.0.32.52.0.0.0.0.203.77.72.92.10.118.252.115",

"sequence" : 6

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Resourcewasretrievedsuccessfully. Schedule

Example data

Content-Type: application/json

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500

NetWorker 9.1.x REST API Reference Guide. 176

Dell Customer Communication - Confidential

Up GET /schedules

Returns a list of Schedules. (getSchedules)

This operation can be used to obtain the information on all the schedules. It describes a sequence of levels controlling the amount of data saved by NetWorker clients.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

ScheduleList

Example data

Content-Type: application/json

{

"count" : 2,

"schedules" : [ {

"levels" : [ "full", "incr", "incr", "incr", "incr", "incr",

"full" ],

"links" : [ {

"href" :

"https://10.118.252.115:9090/nwrestapi/v3/global/schedules/Default",

"rel" : "item"

} ],

"flag" : "default_editable",

"name" : "Default",

"overrides" : [ ],

"period" : "Month",

"resourceId" : {

"id" : "52.0.176.29.0.0.0.0.178.31.10.92.10.118.252.115",

NetWorker 9.1.x REST API Reference Guide. 177

Dell Customer Communication - Confidential

"sequence" : 3

}

}, {

"levels" : [ "full", "incr", "incr", "incr", "incr", "incr",

"incr", "full", "incr", "incr", "incr", "incr", "incr", "incr",

"full", "incr", "incr", "incr", "incr", "incr", "incr", "full",

"incr", "incr", "incr", "incr", "incr", "incr", "full", "incr",

"incr" ],

"links" : [ {

"href" :

"https://10.118.252.115:9090/nwrestapi/v3/global/schedules/test",

"rel" : "item"

} ],

"name" : "test",

"overrides" : [ {

"date" : "1/2/2019",

"level" : "incr"

}, {

"date" : "1/2/2019",

"level" : "full"

} ],

"period" : "Month",

"resourceId" : {

"id" : "45.0.32.52.0.0.0.0.203.77.72.92.10.118.252.115",

"sequence" : 6

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Schedule resources are retrieved successfully. ScheduleList

Example data

Content-Type: application/json

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

NetWorker 9.1.x REST API Reference Guide. 178

Dell Customer Communication - Confidential

404 NotFoundErrorResponse

500

Up POST /schedules

Creates a new schedule resource. (postSchedule)

This operation can be used to create a new schedule.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

schedule Schedule (required) Body Parameter Schedule resource to be created.

Return type

EmptyResponse

Example data

Content-Type: application/json

{

"levels": [

"incr",

"incr",

"incr",

"incr",

"incr",

"incr",

"full",

"incr",

"txnlog"

],

"name": "test",

"overrides": [

{

"date": "1/2/2019",

"level": "incr_synth_full"

},

{

"level": "full",

"pattern": "every month"

NetWorker 9.1.x REST API Reference Guide. 179

Dell Customer Communication - Confidential

}

],

"period": "Month"

}

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Resource is created successfully. EmptyResponse

Up PUT /schedules/{scheduleName}

Updates the specific schedule. (putSchedule)

This operation can be used to modify the attributes of a specific schedule.

Path parameters

scheduleName (required) Path Parameter is the value of the name attribute in the schedule object.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

schedule Schedule (required) Body Parameter schedule for update.

Return type

EmptyResponse

Example data

NetWorker 9.1.x REST API Reference Guide. 180

Dell Customer Communication - Confidential

Content-Type: application/json

{

"levels":[

"full",

"incr",

"incr",

"incr",

"incr",

"incr",

"incr",

"full",

"incr",

"incr",

"incr",

"incr",

"incr",

"incr",

"full",

"incr",

"incr",

"incr",

"incr",

"incr",

"incr",

"full",

"incr",

"incr",

"incr",

"incr",

"incr",

"incr",

"full",

"incr",

"txnlog"

],

"name":"test",

"overrides":[

{

"date":"1/2/2019",

"level":"incr_synth_full"

},

{

"level":"incr",

"pattern":"every month"

}

],

"period":"Month"

}

NetWorker 9.1.x REST API Reference Guide. 181

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Schedule is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500

Server

Up DELETE /usergroups/{userGroupId}

Deletes the specific user group. (deleteUserGroup)

This operation can be used to delete the specific user group.

Path parameters

userGroupId (required) Path Parameter is the value of the name attribute in the user group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 182

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 User group is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /auditlogconfig

Returns the security audit log settings. (getAuditLogConfig)

This operation can be used to retrieve the security audit log settings. NetWorker server enables security audit logging by default and each NetWorker client is automatically configured.

Return type

AuditLogConfiguration

Example data

Content-Type: application/json

{

"administrators" : [ "user=root,host=rhel67_base",

"user=administrator,host=rhel67_base",

"user=system,host=rhel67_base", "user=nsrnmc,host=rhel67_base" ],

"auditLogFilePath" : "/nsr/logs",

"auditLogHostname" : "rhel67_base",

"auditLogMaxFileSizeInMB" : 2,

"auditLogMaxFileVersion" : 0,

"auditLogRenderedService" : "None",

"auditLogSeverity" : "Error",

"name" : "rhel67_base_sec_audit.raw",

"resourceId" : {

"id" : "5.0.171.113.0.0.0.0.99.124.205.91.10.118.244.205",

NetWorker 9.1.x REST API Reference Guide. 183

Dell Customer Communication - Confidential

"sequence" : 1

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the audit log config are retrieved successfully. AuditLogConfiguration

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 500 InternalServerErrorResponse

Up GET /serverconfig

Returns server configuration settings. (getServerConfig)

This operation can be used to retrieve the information about the NetWorker server configuration setting. The NetWorker server configuration setting represents configurable parameters for the NetWorker server.

Return type

ServerConfiguration

Example data

Content-Type: application/json

{

"acceptNewRecoverSessions" : true,

"acceptNewSessions" : true,

"aclPassthrough" : true,

"administrators" : [ "group=Administrators,host=host_name_1",

"user=administrator,host=host_name_1", "user=system,host=host_name_1"

],

"authenticationProxyPort" : 7999,

NetWorker 9.1.x REST API Reference Guide. 184

Dell Customer Communication - Confidential

"authenticationServiceDatabase" : "C:\\Program Files\\EMC

NetWorker\\nsr\\authc-server\\tomcat\\data",

"authenticationServicePort" : 9090,

"clpRefresh" : "No",

"clpUom" : "1",

"deviceSharingMode" : "MaximalSharing",

"disableRpsClone" : true,

"jobInactivityTimeout" : 0,

"jobsdbRetentionInHours" : 72,

"keepIncompleteBackups" : false,

"manualSaves" : true,

"name" : "host_name_1",

"nasDevicePolicyAllowed" : true,

"parallelism" : 32,

"publicArchives" : false,

"resourceId" : {

"id" : "2.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 8

},

"saveSessionDistribution" : "MaxSessions",

"serverOSType" : "Windows NT Server on Intel",

"vmwarePolicyAllowed" : true,

"vmwsEnable" : false,

"vmwsPort" : 8080,

"vmwsUserName" : "VMUser",

"vmwsUserPassword" : "*******",

"volumePriority" : "NearLinePriority",

"wormPoolsOnlyHoldWormTapes" : true,

"wormTapesOnlyInWormPools" : true

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Server configuration settings are retrieved successfully. ServerConfiguration

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500

NetWorker 9.1.x REST API Reference Guide. 185

Dell Customer Communication - Confidential

InternalServerErrorResponse

Up GET /servermessages

Returns a list of server messages. (getServerMessages)

This operation can be used to retrieve the information about all the server messages. However, the query parameters can be used to filter the response. A server message represents concise recent general I18N messages about the status of the server.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

ServerMessageList

Example data

Content-Type: application/json

{

"count" : 3,

"serverMessages" : [ {

"category" : "policy",

"id" : "0000000239",

"message" : "Group TEST_PG waiting for 1 jobs (0 awaiting

restart) to complete.\n",

"priority" : "info",

"source" : "event",

"timestamp" : "2018-10-23T01:20:08-04:00"

}, {

"category" : "policy",

NetWorker 9.1.x REST API Reference Guide. 186

Dell Customer Communication - Confidential

"id" : "0000000238",

"message" : "Starting action 'backup' for workflow

'TEST/TEST_WF'",

"priority" : "notice",

"source" : "event",

"timestamp" : "2018-10-23T01:20:02-04:00"

}, {

"category" : "policy",

"id" : "0000000237",

"message" : "Starting workflow 'TEST/TEST_WF'",

"priority" : "notice",

"source" : "event",

"timestamp" : "2018-10-23T01:20:02-04:00"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Server messages are retrieved successfully. ServerMessageList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /serverstatistics

Returns server statistics. (getServerStatistics)

This operation can be used to retrieve the NetWorker server statistics. The NetWorker server statistics represent read-only statistics of the NetWorker server.

Return type

ServerStatistics

Example data

NetWorker 9.1.x REST API Reference Guide. 187

Dell Customer Communication - Confidential

Content-Type: application/json

{

"badRecovers" : 0,

"badSaves" : 0,

"currentRecovers" : 0,

"currentSaves" : 0,

"maxRecovers" : 0,

"maxSaves" : 2,

"recoverSize" : {

"unit" : "KB",

"value" : 0

},

"recovers" : 0,

"saveSize" : {

"unit" : "KB",

"value" : 228016

},

"saves" : 38,

"upSince" : "2018-10-18T03:18:50-04:00",

"version" : "NetWorker 18.2.0.0.Build.13 Eval"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Server statistics are retrieved successfully. ServerStatistics

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /usergroups/{userGroupId}

Returns the specific user group. (getUserGroup)

This operation can be used to retrieve the information about the specific user group.

NetWorker 9.1.x REST API Reference Guide. 188

Dell Customer Communication - Confidential

Path parameters

userGroupId (required) Path Parameter is the value of the name attribute in the user group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

UserGroup

Example data

Content-Type: application/json

{

"comment" : "This new user group",

"externalRoles" : [ ],

"links" : [ ],

"name" : "UserGroupExample",

"privileges" : [ "ViewSecuritySettings" ],

"resourceId" : {

"id" : "179.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"users" : [ "group=Administrators,host=host_name_1",

"user=administrator,host=host_name_1", "user=system,host=host_name_1"

]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the user group is retrieved successfully. UserGroup

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 189

Dell Customer Communication - Confidential

Up GET /usergroups

Returns a list of user groups. (getUserGroups)

This attribute can be used to retrieve the information on all the user groups. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

UserGroupList

Example data

Content-Type: application/json

{

"count" : 2,

"userGroups" : [ {

"comment" : "Members of this group can perform the application

administration of NetWorker.",

"externalRoles" : [ "cn=Administrators,cn=Groups,dc=host_name_1"

],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/usergroups/Application%2BAdministrators",

"rel" : "item"

} ],

"name" : "Application Administrators",

"privileges" : [ "RemoteAccessAllClients", "ConfigureNetWorker",

"OperateNetWorker", "MonitorNetWorker", "OperateDevicesAndJukeboxes",

"RecoverLocalData", "RecoverRemoteData", "BackupLocalData",

"BackupRemoteData", "ArchiveData", "CreateApplicationSettings",

NetWorker 9.1.x REST API Reference Guide. 190

Dell Customer Communication - Confidential

"ViewApplicationSettings", "ChangeApplicationSettings",

"DeleteApplicationSettings" ],

"resourceId" : {

"id" : "118.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 2

},

"users" : [ "group=Administrators,host=host_name_1",

"user=administrator,host=host_name_1", "user=system,host=host_name_1"

]

}, {

"comment" : "Members of this group can archive local data",

"externalRoles" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/usergroups/Archive%2BUsers",

"rel" : "item"

} ],

"name" : "Archive Users",

"privileges" : [ "ArchiveData" ],

"resourceId" : {

"id" : "159.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"users" : [ ]

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the user groups are retrieved successfully. UserGroupList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /usergroups

NetWorker 9.1.x REST API Reference Guide. 191

Dell Customer Communication - Confidential

Creates a new user group. (postUserGroups)

This operation can be used to create a new user group.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

usergroups UserGroup (required) Body Parameter User group to be created.

Request headers: This header must specify the content type of

request payload as application/json.

Example request body

Content-Type: application/json

{

"comment": "This new user group",

"externalRoles": [],

"name": "UserGroupExample",

"privileges": [

"ViewSecuritySettings"

],

"users": [

"group=Administrators,host=host_name_1",

"user=administrator,host=host_name_1",

"user=system,host=host_name_1"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 192

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 User group is created successfully. The user group resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /auditlogconfig

Updates the security audit log settings. (putAuditLogConfig)

This attribute can be used to update the security audit log settings. NetWorker enables security audit logging by default and each NetWorker client is automatically configured. Any changes in audit logging settings will be automatically communicated to the NetWorker clients.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

auditLogConfig AuditLogConfiguration (optional) Body Parameter Audit log settings for update.

Example request body

Content-Type: application/json

{

"administrators": [

NetWorker 9.1.x REST API Reference Guide. 193

Dell Customer Communication - Confidential

"group=Administrators,host=host_name_1",

"user=administrator,host=host_name_1",

"user=system,host=host_name_1"

],

"auditLogFilePath": "C:\\Program Files\\EMC

NetWorker\\nsr\\logs_new_folder",

"auditLogHostname": "host_name_1",

"auditLogMaxFileSizeInMB": 2,

"auditLogMaxFileVersion": 0,

"auditLogRenderedService": "None",

"auditLogSeverity": "Error"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Security audit log settings is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 500 InternalServerErrorResponse

Up PUT /serverconfig

Updates the server configuration settings. (putServerConfig)

This operation can be used to modify the server configuration settings of the NetWorker server.

NetWorker 9.1.x REST API Reference Guide. 194

Dell Customer Communication - Confidential

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

serverConfig ServerConfiguration (optional) Body Parameter Server configuration settings for update.

Example request body

Content-Type: application/json

{

"acceptNewRecoverSessions": true,

"acceptNewSessions": true,

"saveSessionDistribution": "MaxSessions",

"serverOSType": "Windows NT Server on Intel",

"vmwarePolicyAllowed": true,

"vmwsEnable": true,

"vmwsPort": 8080,

"vmwsUserName": "VMUser",

"wormPoolsOnlyHoldWormTapes": true,

"wormTapesOnlyInWormPools": true

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Server configuration is updated successfully. EmptyResponse

400

NetWorker 9.1.x REST API Reference Guide. 195

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /usergroups/{userGroupId}

Updates the specific user group. (putUserGroups)

This operation can be used to update the specific user group.

Path parameters

userGroupId (required) Path Parameter is the value of the name attribute in the user group resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

userGroup UserGroup (required) Body Parameter User group data for the update.

Example request body

Content-Type: application/json

{

"comment": "Members of this group can audit the

NetWorker security logs is updated for example.",

"users": [

"group=Administrators,host=host_name_1",

"user=administrator,host=host_name_1",

"user=system,host=host_name_1"

]

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

NetWorker 9.1.x REST API Reference Guide. 196

Dell Customer Communication - Confidential

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 User group is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Sessions

Up GET /sessions/{sessionId}

Returns the specific session. (getSession)

This operation can be used to retrieve the information about the specific session.

Path parameters

sessionId (required) Path Parameter is the value of the id attribute in the session resource.

Return type

Session

Example data

Content-Type: application/json

{

"clientHostname" : "host_name_1",

"completed" : true,

"compressionRatio" : 0,

NetWorker 9.1.x REST API Reference Guide. 197

Dell Customer Communication - Confidential

"device" : "aftd",

"deviceFamily" : "Disk",

"deviceType" : "adv_file",

"endTime" : "2018-10-21T10:00:13-04:00",

"id" : 7524,

"itemIdLong" : 7524,

"jobId" : 72,

"links" : [ ],

"mode" : "Saving",

"pool" : "Default",

"protectionGroup" : "Server Protection",

"rootJobId" : 70,

"saveSet" : "index:d5b545cb-00000004-5bc83451-5bc83450-00015000-

360c1a56",

"saveSetId" : "b7bf16d3-00000006-ebcc8669-5bcc8669-00175000-

360c1a56",

"size" : {

"unit" : "KB",

"value" : 315

},

"startTime" : "2018-10-21T10:00:09-04:00",

"stopped" : true,

"transferRate" : {

"unit" : "KB/s",

"value" : 0

},

"volume" : "bob_restapi.001"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the session is retrieved successfully. Session

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 198

Dell Customer Communication - Confidential

Up GET /sessions

Returns a list of sessions. (getSessions)

This operation can be used to retrieve the information about the sessions on the NetWorker server. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

SessionList

Example data

Content-Type: application/json

{

"count" : 3,

"sessions" : [ {

"clientHostname" : "host_name_1",

"completed" : true,

"compressionRatio" : 0,

"device" : "aftd",

"deviceFamily" : "Disk",

"deviceType" : "adv_file",

"endTime" : "2018-10-23T01:51:01-04:00",

"id" : 7541,

"itemIdLong" : 7541,

"jobId" : 124,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/sessions/7541",

"rel" : "item"

NetWorker 9.1.x REST API Reference Guide. 199

Dell Customer Communication - Confidential

} ],

"mode" : "Saving",

"pool" : "Default",

"protectionGroup" : "TEST_PG",

"rootJobId" : 116,

"saveSet" : "E:\\file1.txt",

"saveSetId" : "21b3fa87-00000006-daceb6c3-5bceb6c3-00285000-

360c1a56",

"size" : {

"unit" : "KB",

"value" : 0

},

"startTime" : "2018-10-23T01:50:58-04:00",

"stopped" : true,

"transferRate" : {

"unit" : "KB/s",

"value" : 0

},

"volume" : "bob_restapi.001"

}, {

"clientHostname" : "host_name_1",

"completed" : true,

"compressionRatio" : 0,

"device" : "aftd",

"deviceFamily" : "Disk",

"deviceType" : "adv_file",

"endTime" : "2018-10-23T01:51:01-04:00",

"id" : 7540,

"itemIdLong" : 7540,

"jobId" : 123,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/sessions/7540",

"rel" : "item"

} ],

"mode" : "Saving",

"pool" : "Default",

"protectionGroup" : "TEST_PG",

"rootJobId" : 116,

"saveSet" : "E:\\file2.txt",

"saveSetId" : "64481d25-00000006-dbceb6c3-5bceb6c3-00275000-

360c1a56",

"size" : {

"unit" : "KB",

"value" : 0

},

"startTime" : "2018-10-23T01:50:58-04:00",

"stopped" : true,

"transferRate" : {

"unit" : "KB/s",

NetWorker 9.1.x REST API Reference Guide. 200

Dell Customer Communication - Confidential

"value" : 0

},

"volume" : "bob_restapi.001"

}, {

"clientHostname" : "host_name_1",

"completed" : true,

"compressionRatio" : 0,

"device" : "aftd",

"deviceFamily" : "Disk",

"deviceType" : "adv_file",

"endTime" : "2018-10-23T01:50:41-04:00",

"id" : 7539,

"itemIdLong" : 7539,

"jobId" : 122,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/sessions/7539",

"rel" : "item"

} ],

"mode" : "Saving",

"pool" : "Default",

"protectionGroup" : "TEST_PG",

"rootJobId" : 113,

"saveSet" : "E:\\file1.txt",

"saveSetId" : "2108a6b6-00000006-dcceb6ae-5bceb6ae-00265000-

360c1a56",

"size" : {

"unit" : "KB",

"value" : 0

},

"startTime" : "2018-10-23T01:50:38-04:00",

"stopped" : true,

"transferRate" : {

"unit" : "KB/s",

"value" : 0

},

"volume" : "bob_restapi.001"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 201

Dell Customer Communication - Confidential

200 Information about the sessions is retrieved successfully. SessionList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /sessions/{sessionId}/op/cancel

Cancels the specified session. (postSessionOpCancel)

This operation can be used to cancel the specific session.

Path parameters

sessionId (required) Path Parameter is the value of the id attribute in the session resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

jobOpCancel JobOpCancel (required) Body Parameter Cancel parameters.

Example request body

Content-Type: application/json

{ }

Request headers: This header must specify the content type of

request payload as application/json.

Return type

InfoResponse

Example data

NetWorker 9.1.x REST API Reference Guide. 202

Dell Customer Communication - Confidential

Content-Type: application/json

{

"text" : "The request is accepted. To retrieve its status, issue an

HTTP GET request to URL specified in the 'Location' response header."

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 Job cancellation request has been accepted. InfoResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Storagenodes

Up DELETE /storagenodes/{storageNodeId}

Deletes the specific storage node from the NetWorker instance. (deleteStorageNode)

This operation can be used to delete the specific storage node.

Path parameters

storageNodeId (required) Path Parameter is the value of the name attribute in the storage node resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

NetWorker 9.1.x REST API Reference Guide. 203

Dell Customer Communication - Confidential

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Storage node is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /storagenodes/{storageNodeId}

Returns the specific storage node. (getStorageNode)

This operation can be used to retrieve the information about the specific storage node.

Path parameters

storageNodeId (required) Path Parameter is the value of the name attribute in the storage node resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

StorageNode

Example data

Content-Type: application/json

{

"aftdAllowedDirectories" : [ ],

"cloneStorageNodes" : [ ],

"configuredDevices" : [ "aftd", "10.31.196.90_vmware" ],

"configuredLibraries" : [ ],

NetWorker 9.1.x REST API Reference Guide. 204

Dell Customer Communication - Confidential

"configuredLibraryTypes" : [ ],

"configuredSiloTypes" : [ ],

"configuredSilos" : [ ],

"daemonVersions" : [ "nsrsnmd:18.2.0.0.Build.13",

"nsrmmd:18.2.0.0.Build.13", "nsrexecd:18.2.0.0.Build.13" ],

"dateOfRegistration" : "2018-10-25T01:30:10-04:00",

"dedicatedStorageNode" : false,

"deviceSharingMode" : "ServerDefault",

"dynamicNsrmmds" : true,

"enabled" : true,

"lastErrorMessages" : [ ],

"lastErrorNumber" : 0,

"links" : [ ],

"name" : "windows2012r2",

"numberOfDevices" : 2,

"numberOfLibraries" : 0,

"ready" : true,

"resourceId" : {

"id" : "191.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"searchAllLuns" : false,

"sharedDeviceCreation" : false,

"storageNodeIsConfigured" : true,

"typeOfStorageNode" : "SCSI",

"usePersistentNames" : false

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the storage node is retrieved successfully. StorageNode

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 205

Dell Customer Communication - Confidential

Up GET /storagenodes

Returns a list of storage nodes. (getStorageNodes)

This attribute can be used to retrieve a list of storage nodes. However, the query parameters can be used to filter the response. Storage nodes are host computers with one or more attached storage devices (disk or tape). The storage node function is to offload most of the data movement in a backup or a recovery operation from the NetWorker server.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

StorageNodeList

Example data

Content-Type: application/json

{

"count" : 2,

"storageNodes" : [ {

"aftdAllowedDirectories" : [ ],

"cloneStorageNodes" : [ ],

"configuredDevices" : [ "aftd", "10.31.196.90_vmware" ],

"configuredLibraries" : [ ],

"configuredLibraryTypes" : [ ],

"configuredSiloTypes" : [ ],

"configuredSilos" : [ ],

"daemonVersions" : [ "nsrsnmd:18.2.0.0.Build.13",

"nsrmmd:18.2.0.0.Build.13", "nsrexecd:18.2.0.0.Build.13" ],

"dateOfRegistration" : "2018-10-18T03:18:44-04:00",

"dedicatedStorageNode" : false,

NetWorker 9.1.x REST API Reference Guide. 206

Dell Customer Communication - Confidential

"deviceSharingMode" : "ServerDefault",

"dynamicNsrmmds" : true,

"enabled" : true,

"lastErrorMessages" : [ ],

"lastErrorNumber" : 0,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/storagenodes/host_name_1",

"rel" : "item"

} ],

"name" : "host_name_1",

"numberOfDevices" : 2,

"numberOfLibraries" : 0,

"ready" : true,

"resourceId" : {

"id" : "36.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 7

},

"searchAllLuns" : false,

"sharedDeviceCreation" : false,

"storageNodeIsConfigured" : true,

"typeOfStorageNode" : "SCSI",

"usePersistentNames" : false,

"version" : "18.2.0.0"

}, {

"aftdAllowedDirectories" : [ ],

"cloneStorageNodes" : [ ],

"configuredDevices" : [ "aftd", "10.31.196.90_vmware" ],

"configuredLibraries" : [ ],

"configuredLibraryTypes" : [ ],

"configuredSiloTypes" : [ ],

"configuredSilos" : [ ],

"daemonVersions" : [ "nsrsnmd:18.2.0.0.Build.13",

"nsrmmd:18.2.0.0.Build.13", "nsrexecd:18.2.0.0.Build.13" ],

"dateOfRegistration" : "2018-10-25T01:30:10-04:00",

"dedicatedStorageNode" : false,

"deviceSharingMode" : "ServerDefault",

"dynamicNsrmmds" : true,

"enabled" : true,

"lastErrorMessages" : [ ],

"lastErrorNumber" : 0,

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/storagenodes/windows2012r2",

"rel" : "item"

} ],

"name" : "windows2012r2",

"numberOfDevices" : 2,

"numberOfLibraries" : 0,

"ready" : true,

NetWorker 9.1.x REST API Reference Guide. 207

Dell Customer Communication - Confidential

"resourceId" : {

"id" : "191.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"searchAllLuns" : false,

"sharedDeviceCreation" : false,

"storageNodeIsConfigured" : true,

"typeOfStorageNode" : "SCSI",

"usePersistentNames" : false

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the storage nodes are retrieved successfully. StorageNodeList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /storagenodes

Creates a new storage node. (postStorageNodes)

This attribute can be used to create a new storage node. Storage nodes are host computers with one or more attached storage devices (disk or tape). The storage node function is to offload most of the data movement in a backup or a recovery operation from the NetWorker server.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

NetWorker 9.1.x REST API Reference Guide. 208

Dell Customer Communication - Confidential

Request body

storageNode StorageNode (required) Body Parameter Storage node to be created.

Example request body

Content-Type: application/json

{

"configuredDevices": [

"aftd",

"10.31.196.90_vmware"

],

"daemonVersions": [

"nsrsnmd:18.2.0.0.Build.13",

"nsrmmd:18.2.0.0.Build.13",

"nsrexecd:18.2.0.0.Build.13"

],

"dedicatedStorageNode": false,

"deviceSharingMode": "ServerDefault",

"dynamicNsrmmds": true,

"enabled": true,

"lastErrorNumber": 0,

"name": "windows2012r2",

"numberOfDevices": 2,

"numberOfLibraries": 0,

"ready": true,

"searchAllLuns": false,

"sharedDeviceCreation": false,

"storageNodeIsConfigured": true,

"typeOfStorageNode": "SCSI",

"usePersistentNames": false

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 209

Dell Customer Communication - Confidential

application/json

Responses

201 Storage node is created successfully. The storage node resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /storagenodes/{storageNodeId}

(putStorageNode)

Updates the specific storage node.

Path parameters

storageNodeId (required) Path Parameter is the value of the name attribute in the storage node resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Request body

storageNode StorageNode (required) Body Parameter Storage node data for the update.

Example request body

Content-Type: application/json

{

"configuredDevices": [

"aftd",

"10.31.196.90_vmware"

],

"daemonVersions": [

"nsrsnmd:18.2.0.0.Build.13",

"nsrmmd:18.2.0.0.Build.13",

"nsrexecd:18.2.0.0.Build.13"

],

"dedicatedStorageNode": false,

NetWorker 9.1.x REST API Reference Guide. 210

Dell Customer Communication - Confidential

"deviceSharingMode": "ServerDefault",

"dynamicNsrmmds": true,

"enabled": true,

"lastErrorNumber": 0,

"name": "host_name_1",

"numberOfDevices": 2,

"numberOfLibraries": 0,

"ready": true,

"searchAllLuns": false,

"sharedDeviceCreation": false,

"storageNodeIsConfigured": true,

"typeOfStorageNode": "SCSI",

"usePersistentNames": false

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Storage node is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Tenants

NetWorker 9.1.x REST API Reference Guide. 211

Dell Customer Communication - Confidential

Up DELETE /tenants/{tenantId}

Deletes the specific tenant. (deleteTenant)

This operation can be used to delete a tenant from NetWorker. A tenant provides information about a NetWorker tenant.

Path parameters

tenantId (required) Path Parameter is the value of the id attribute of the tenant resource's resourceId.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Tenant is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /tenants/{tenantId}

Returns the specific tenant. (getTenant)

This operation can fetch the information about the specific tenant. A tenant provides information about a NetWorker tenant.

Path parameters

NetWorker 9.1.x REST API Reference Guide. 212

Dell Customer Communication - Confidential

tenantId (required) Path Parameter is the value of the id attribute of the tenant resource's resourceId.

Return type

Tenant

Example data

Content-Type: application/json

{

"clientHostnames" : [ "host_name_1" ],

"devices" : [ ],

"directives" : [ ],

"externalRoles" : [ ],

"jukeboxes" : [ ],

"labels" : [ ],

"links" : [ ],

"name" : "TenentExample1",

"numberOfClients" : 1,

"numberOfDevices" : 0,

"numberOfJukeboxes" : 0,

"numberOfStorageNodes" : 0,

"pools" : [ ],

"privileges" : [ ],

"protectionGroups" : [ "Bronze-ApplicationExample" ],

"protectionPolicies" : [ ],

"recovers" : [ ],

"resourceId" : {

"id" : "190.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"storageNodes" : [ ],

"users" : [ ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specified tenant is retrieved successfully. Tenant

400

NetWorker 9.1.x REST API Reference Guide. 213

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /tenants

Returns a list of tenants. (getTenants)

This operation can be used to retrieve the information about all the tenants in the NetWorker instance. However, the query parameters can be used to filter the response. A tenant provides information about a NetWorker tenant.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

TenantList

Example data

Content-Type: application/json

{

"count" : 2,

"tenants" : [ {

"clientHostnames" : [ ],

"devices" : [ ],

"directives" : [ ],

NetWorker 9.1.x REST API Reference Guide. 214

Dell Customer Communication - Confidential

"externalRoles" : [ ],

"jukeboxes" : [ ],

"labels" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/tenants/189.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176",

"rel" : "item"

} ],

"name" : "TenentExample",

"numberOfClients" : 0,

"numberOfDevices" : 0,

"numberOfJukeboxes" : 0,

"numberOfStorageNodes" : 0,

"pools" : [ ],

"privileges" : [ ],

"protectionGroups" : [ ],

"protectionPolicies" : [ ],

"recovers" : [ ],

"resourceId" : {

"id" : "189.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

},

"storageNodes" : [ ],

"users" : [ ]

}, {

"clientHostnames" : [ "host_name_1" ],

"devices" : [ ],

"directives" : [ ],

"externalRoles" : [ ],

"jukeboxes" : [ ],

"labels" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/tenants/190.0.120.52.0.0.0.0.210.51.200.9

1.10.207.81.176",

"rel" : "item"

} ],

"name" : "TenentExample1",

"numberOfClients" : 1,

"numberOfDevices" : 0,

"numberOfJukeboxes" : 0,

"numberOfStorageNodes" : 0,

"pools" : [ ],

"privileges" : [ ],

"protectionGroups" : [ "Bronze-ApplicationExample" ],

"protectionPolicies" : [ ],

"recovers" : [ ],

"resourceId" : {

"id" : "190.0.120.52.0.0.0.0.210.51.200.91.10.207.81.176",

"sequence" : 1

NetWorker 9.1.x REST API Reference Guide. 215

Dell Customer Communication - Confidential

},

"storageNodes" : [ ],

"users" : [ ]

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the tenants are retrieved successfully. TenantList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /tenants

Creates a new tenant. (postTenant)

This operation can be used to create a NetWorker tenant. A tenant provides information about a NetWorker tenant.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

tenant Tenant (required) Body Parameter Tenant to be created.

Example request body

NetWorker 9.1.x REST API Reference Guide. 216

Dell Customer Communication - Confidential

Content-Type: application/json

{

"clientHostnames": [

"host_name_1"

],

"protectionGroups": [

"Bronze-ApplicationExample"

],

"numberOfClients": 1,

"name": "TenentExample1"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A new tenant is created successfully. The tenant resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /tenants/{tenantId}

Updates the specific tenant. (putTenant)

NetWorker 9.1.x REST API Reference Guide. 217

Dell Customer Communication - Confidential

This operation can be used to modify the attributes of a tenant. A tenant provides information about a NetWorker tenant.

Path parameters

tenantId (required) Path Parameter is the value of the id attribute of the tenant resource's resourceId.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

tenant Tenant (required) Body Parameter Tenant data for the update.

Example request body

Content-Type: application/json

{

"dataSourceType": "VMware",

"definitions": [

{

"operator": "Contains",

"property": "Name",

"type": "VirtualMachine",

"value": "rehl"

}

],

"matchType": "All",

"name": "Example_rule"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 218

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Tenant attributes are updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Vmware

Up DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id}

Deletes the specific VM browse session. (deleteBackupVProxyVmBrowseSession)

This operation can be used to delete the specific VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required)

NetWorker 9.1.x REST API Reference Guide. 219

Dell Customer Communication - Confidential

Path Parameter is the value of the sessionId attribute of the session's config resource.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 VM browse session is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up DELETE /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}/vmbrowse/{vproxy-browse-session-id}

Deletes the specific VM browse session. (deleteInstanceVProxyVmBrowseSession)

This operation can be used to delete the specific VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

NetWorker 9.1.x REST API Reference Guide. 220

Dell Customer Communication - Confidential

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config resource.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 VM browse session is deleted successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up DELETE /vmware/vcenters/{vcenter-hostname}

Deletes the specific vCenter from the NetWorker instance. (deleteVCenter)

This operation can be used to delete a specific vCenter from NetWorker. vCenter provides a central point of control for managing, monitoring, provisioning, and migrating virtual machines in the VMware ecosystem.

Path parameters

vcenter-hostname (required)

NetWorker 9.1.x REST API Reference Guide. 221

Dell Customer Communication - Confidential

Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 vCenter is deleted successfully from NetWorker. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up DELETE /vmware/vproxies/{vproxy-hostname}

Deletes the specific vProxy. (deleteVProxy)

This operation can be used to delete a specific vProxy appliance from the NetWorker instance.

Path parameters

vproxy-hostname (required) Path Parameter is the value of hostname attribute in the vProxy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

NetWorker 9.1.x REST API Reference Guide. 222

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 vProxy is deleted successfully from NetWorker. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id}/contents

Returns the content of a single VM browse session. (getBackupVProxyVmBrowseSessionContents)

This operation can be used to fetch the content of a single VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding needs to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config resource.

NetWorker 9.1.x REST API Reference Guide. 223

Dell Customer Communication - Confidential

Query parameters

PageSize (optional) Query Parameter The PageSize parameter specifies the default page size for the API. Use this parameter to specify the number of items to be displayed per page. Based on the setting, the server returns a set of pages with the specified number of items per page. By default, all query results are displayed on one page. Set the PageSize parameter to a value greater than 0.

PageNumber (optional) Query Parameter The PageNumber parameter specifies the page number.

Return type

XmlVmBrowseDirectoryContents

Example data

Content-Type: application/json

{

"error" : {

"text" : "",

"code" : "0"

},

"noMoreData" : "true",

"totalObjects" : "26",

"freeSpace" : "1915236352",

"fileList" : [ {

"fileName" : "etc",

"fileType" : "directory",

"fileSize" : "0",

"fileModificationTime" : "2018-03-20T05:25:46Z"

}, {

"fileName" : "recover",

"fileType" : "directory",

"fileSize" : "0",

"fileModificationTime" : "2018-02-07T10:33:27Z"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 224

Dell Customer Communication - Confidential

200 Content of a single browse session is retrieved successfully. XmlVmBrowseDirectoryContents

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id}

Returns the specific VM browse session. (getBackupVProxyVmBrowseSessionResponse)

This operation can be used to fetch information about the specific VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config resource.

Return type

VProxyVmBrowseSessionResponse

Example data

Content-Type: application/json

{

"config" : {

"sessionId" : "cbe0c2be-5979-4cba-8beb-d7a0af6f61d8",

NetWorker 9.1.x REST API Reference Guide. 225

Dell Customer Communication - Confidential

"browseDestination" : "false",

"cacheRetentionSeconds" : "60",

"currentWorkingDirectory" : "E:\\",

"idleTimeout" : "300"

},

"links" : [ {

"href" :

"https://10.207.86.34:9090/nwrestapi/v3/global/vmware/vcenters/10.207

.86.28/protectedvms/500c8452-2be3-19dd-ce36-

854a1d4d4cde/backups/3356bee8-00000006-f00e8b12-5a0e8b12-00115000-

a6138c56/op/vmmount/4d8e3404-bb5e-44cc-

806bb69e1b0d4544/vmbrowse/cbe0c2be-5979-4cba-8beb-

d7a0af6f61d8/contents",

"title" : "VM browse contents"

} ],

"status" : {

"state" : "Success",

"description" : "Fetched directory contents of 'E:\\'"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific VM browse session is retrieved successfully. VProxyVmBrowseSessionResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse

Returns a list of all VM browse sessions. (getBackupVProxyVmBrowseSessionResponseList)

NetWorker 9.1.x REST API Reference Guide. 226

Dell Customer Communication - Confidential

This operation can be used to fetch information on all VM browse sessions.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

Return type

VProxyVmBrowseSessionResponseList

Example data

Content-Type: application/json

{

"count" : 1,

"sessions" : [ {

"config" : {

"sessionId" : "cbe0c2be-5979-4cba-8beb-d7a0af6f61d8",

"browseDestination" : "false",

"cacheRetentionSeconds" : "60",

"currentWorkingDirectory" : "E:\\",

"idleTimeout" : "300"

},

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/10.207.86.28/protectedvms

/500c8452-2be3-19dd-ce36-854a1d4d4cde/backups/3356bee8-00000006-

f00e8b12-5a0e8b12-00115000-a6138c56/op/vmmount/4d8e3404-bb5e-44cc-

806bb69e1b0d4544/vmbrowse/cbe0c2be-5979-4cba-8beb-

d7a0af6f61d8/contents",

"title" : "VM browse contents"

} ],

"status" : {

"state" : "Success",

"description" : "Fetched directory contents of 'C:\\Program

Files (x8 )\\EMC\\Vproxy FLR Agent

\\flr\\mountpoints\\FLR116562623\\E'"

}

} ]

NetWorker 9.1.x REST API Reference Guide. 227

Dell Customer Communication - Confidential

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information on all VM browse sessions is retrieved successfully. VProxyVmBrowseSessionResponseList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-id}

Returns the specific mount session. (getBackupVProxyVmMountSessionResponse)

This operation can be used to retrieve the information about the specific mount session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy mount job resource.

Return type

NetWorker 9.1.x REST API Reference Guide. 228

Dell Customer Communication - Confidential

VProxyVmMountSessionResponse

Example data

Content-Type: application/json

{

"config" : {

"idleTimeout" : 1200,

"mountPointPath" : "C:\\Program Files (x86)\\EMC\\vProxy FLR

Agent\\flr\\mountpoints\\FLR564443310"

},

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/10.118.245.95/protectedvm

s/50231baf-6281-5d7b-09f6-5591a691017b/backups/b7d8dce8-00000006-

fdd15bfb-5bd15bfb-00045000-

f6053256/instances/1540447227/op/vmmount/d23993d6-21c0-4894-b645-

efd415aecae3/vmbrowse",

"title" : "Vm browse session"

} ],

"status" : {

"description" : "End of mount request processing; mountpoint is

'C:\\Program Files (x86)\\EMC\\vProxy FLR

Agent\\flr\\mountpoints\\FLR564443310' (no error)",

"state" : "Mounted"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information on the specific mount session is retrieved successfully. VProxyVmMountSessionResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 229

Dell Customer Communication - Confidential

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}/vmbrowse/{vproxy-browse-session-id}/contents

Returns content of a single vmbrowse session. (getInstanceVProxyVmBrowseSessionContents)

This operation can be used to fetch the content of a single vmbrowse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding needs to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter Specifies the ID of the vproxy vm browse session.

Query parameters

PageSize (optional) Query Parameter The PageSize parameter specifies the default page size for the API. Use this parameter to specify the number of items to be displayed per page. Based on the setting, the server returns a set of pages with the specified number of items per page. By default, all query results are displayed on one page. Set the PageSize parameter to a value greater than 0.

PageNumber (optional) Query Parameter The PageNumber parameter specifies the page number.

Return type

XmlVmBrowseDirectoryContents

Example data

Content-Type: application/json

{

"error" : {

NetWorker 9.1.x REST API Reference Guide. 230

Dell Customer Communication - Confidential

"text" : "",

"code" : "0"

},

"noMoreData" : "true",

"totalObjects" : "26",

"freeSpace" : "1915236352",

"fileList" : [ {

"fileName" : "etc",

"fileType" : "directory",

"fileSize" : "0",

"fileModificationTime" : "2018-03-20T05:25:46Z"

}, {

"fileName" : "recover",

"fileType" : "directory",

"fileSize" : "0",

"fileModificationTime" : "2018-02-07T10:33:27Z"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Content of single browse session is retrieved successfully. XmlVmBrowseDirectoryContents

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}/vmbrowse/{vproxy-browse-session-id}

Returns the specific VM browse session. (getInstanceVProxyVmBrowseSessionResponse)

This operation can be used to fetch information about the specific VM browse session.

NetWorker 9.1.x REST API Reference Guide. 231

Dell Customer Communication - Confidential

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config resource.

Return type

VProxyVmBrowseSessionResponse

Example data

Content-Type: application/json

{

"config" : {

"sessionId" : "cbe0c2be-5979-4cba-8beb-d7a0af6f61d8",

"browseDestination" : "false",

"cacheRetentionSeconds" : "60",

"currentWorkingDirectory" : "E:\\",

"idleTimeout" : "300"

},

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/10.207.86.28/protectedvms

/500c8452-2be3-19dd-ce36-854a1d4d4cde/backups/3356bee8-00000006-

f00e8b12-5a0e8b12-00115000-a6138c56/op/vmmount/4d8e3404-bb5e-44cc-

806bb69e1b0d4544/vmbrowse/cbe0c2be-5979-4cba-8beb-

d7a0af6f61d8/contents",

"title" : "VM browse contents"

} ],

"status" : {

"state" : "Success",

"description" : "Fetched directory contents of 'E:\\'"

}

}

Produces

NetWorker 9.1.x REST API Reference Guide. 232

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific VM browse session is retrieved successfully. VProxyVmBrowseSessionResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}/vmbrowse

Returns a list of all vmbrowse sessions. (getInstanceVProxyVmBrowseSessionResponseList)

This operation can be used to fetch information of all vmbrowse sessions.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

Return type

VProxyVmBrowseSessionResponseList

NetWorker 9.1.x REST API Reference Guide. 233

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"count" : 1,

"sessions" : [ {

"config" : {

"sessionId" : "cbe0c2be-5979-4cba-8beb-d7a0af6f61d8",

"browseDestination" : "false",

"cacheRetentionSeconds" : "60",

"currentWorkingDirectory" : "E:\\",

"idleTimeout" : "300"

},

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/10.207.86.28/protectedvms

/500c8452-2be3-19dd-ce36-854a1d4d4cde/backups/3356bee8-00000006-

f00e8b12-5a0e8b12-00115000-a6138c56/op/vmmount/4d8e3404-bb5e-44cc-

806bb69e1b0d4544/vmbrowse/cbe0c2be-5979-4cba-8beb-

d7a0af6f61d8/contents",

"title" : "VM browse contents"

} ],

"status" : {

"state" : "Success",

"description" : "Fetched directory contents of 'E:\\'"

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information on all VM browse sessions were retrieved successfully. VProxyVmBrowseSessionResponseList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500

NetWorker 9.1.x REST API Reference Guide. 234

Dell Customer Communication - Confidential

InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}

Returns the specific mount session. (getInstanceVProxyVmMountSessionResponse)

This operation can be used to retrieve the information about the specific mount session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

Return type

VProxyVmMountSessionResponse

Example data

Content-Type: application/json

{

"config" : {

"idleTimeout" : 1200,

"mountPointPath" : "C:\\Program Files (x86)\\EMC\\vProxy FLR

Agent\\flr\\mountpoints\\FLR564443310"

},

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/10.118.245.95/protectedvm

s/50231baf-6281-5d7b-09f6-5591a691017b/backups/b7d8dce8-00000006-

fdd15bfb-5bd15bfb-00045000-

f6053256/instances/1540447227/op/vmmount/d23993d6-21c0-4894-b645-

efd415aecae3/vmbrowse",

"title" : "Vm browse session"

} ],

NetWorker 9.1.x REST API Reference Guide. 235

Dell Customer Communication - Confidential

"status" : {

"description" : "End of mount request processing; mountpoint is

'C:\\Program Files (x86)\\EMC\\vProxy FLR

Agent\\flr\\mountpoints\\FLR564443310' (no error)",

"state" : "Mounted"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information on the specific mount session is retrieved successfully. VProxyVmMountSessionResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}

Returns the specific vCenter. (getVCenter)

This operation can fetch the information about the specific vCenter. vCenter provides a central point of control for managing, monitoring, provisioning, and migrating virtual machines in the VMware ecosystem.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

VCenter

NetWorker 9.1.x REST API Reference Guide. 236

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"cloudDeployment" : false,

"hostname" : "blr76231.lss.emc.com",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/op/r

efresh",

"title" : "Refresh vCenter view"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms",

"title" : "List of protected virtual machines"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/vms"

,

"title" : "List of virtual machines"

}, {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/plug

ins",

"title" : "Install vCenter plug-ins"

} ],

"resourceId" : {

"id" : "175.0.249.58.0.0.0.0.64.243.99.91.10.31.79.40",

"sequence" : 12830

},

"userName" : "administrator@vsphere.local",

"userPassword" : "*******"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific vCenter is retrieved successfully. VCenter

400 BadRequestErrorResponse

401

NetWorker 9.1.x REST API Reference Guide. 237

Dell Customer Communication - Confidential

AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-uuid}

Returns a specific protected VM for a specific vCenter. (getVCenterProtectedVm)

This operation can be used to retrieve the information about the specific protected VM, for a specified vCenter.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

Return type

VMwareProtectedVm

Example data

Content-Type: application/json

{

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/500a0a4a-5438-9cda-e5f3-85601f2cee74/backups",

"title" : "List of backups"

} ],

"morefId" : "vm-76",

"name" : "centos-linux-1",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "500a0a4a-5438-9cda-e5f3-85601f2cee74",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}

NetWorker 9.1.x REST API Reference Guide. 238

Dell Customer Communication - Confidential

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific protected VM is retrieved successfully. VMwareProtectedVm

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances

Returns a list of instances (clones) for a specific protected VM backup. (getVCenterProtectedVmBackupInstances)

This operation can be used to fetch the information about the list of backup instances for a specific protected VM backup.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

Return type

BackupInstanceList

Example data

Content-Type: application/json

NetWorker 9.1.x REST API Reference Guide. 239

Dell Customer Communication - Confidential

{

"backupInstances" : [ {

"clone" : false,

"id" : "1534743384",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/500a0a4a-5438-9cda-e5f3-85601f2cee74/backups/830d87fe-

00000006-007a5358-5b7a5358-00015000-b90e9956/instances/1534743384",

"rel" : "item"

} ],

"status" : "Recoverable",

"volumeIds" : [ "6550706" ]

}, {

"clone" : true,

"id" : "1534743728",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/500a0a4a-5438-9cda-e5f3-85601f2cee74/backups/830d87fe-

00000006-007a5358-5b7a5358-00015000-b90e9956/instances/1534743728",

"rel" : "item"

} ],

"status" : "Recoverable",

"volumeIds" : [ "4267963839" ]

} ],

"count" : 2

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the list of instances for a specific protected VM backup is retrieved successfully. BackupInstanceList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 240

Dell Customer Communication - Confidential

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups

Returns a list of backups (save sets) for a specific protected VM. (getVCenterProtectedVmBackups)

This operation can be used to fetch the information about all backups (save sets) for a specific protected VM.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

Return type

BackupList

Example data

Content-Type: application/json

{

"backups" : [ {

"attributes" : [ {

"key" : "**backup start time",

"values" : [ "1534743357" ]

}, {

"key" : "*backup_device",

"values" : [ "Data Domain" ]

}, {

"key" : "*backup_mode",

"values" : [ "VSS" ]

}, {

"key" : "*policy action name",

"values" : [ "backup: 1534743384", "clone: 1534744804" ]

}, {

"key" : "*policy name",

"values" : [ "P5vProxy: 1534743384 1534744804" ]

}, {

"key" : "*policy workflow name",

"values" : [ "WvProxy: 1534743384 1534744804" ]

}, {

"key" : "*policy_workflow_action_path",

"values" : [ "/P5vProxy/WvProxy/backup" ]

NetWorker 9.1.x REST API Reference Guide. 241

Dell Customer Communication - Confidential

}, {

"key" : "*proxy_hostname",

"values" : [ "blr76183.lss.emc.com" ]

}, {

"key" : "*ss clone retention",

"values" : [ " 1534743384: 1534743384:

2724815", " 1534744804: 1534744233: 2724815" ]

}, {

"key" : "*ss data domain backup cloneid",

"values" : [ "1534743384" ]

}, {

"key" : "*ss data domain dedup statistics",

"values" : [ "v1:1534743384:6036698552:1327958:1009477",

"v1:1534744804:6035519477:20772168:20681737" ]

}, {

"key" : "*SSID directory",

"values" : [ "Yes" ]

}, {

"key" : "*vcenter_hostname",

"values" : [ "blr76231.lss.emc.com" ]

}, {

"key" : "*vm_info",

"values" : [ "{\n \"name\": \"Centos2\",\n \"host-name\":

\"\",\n \"ip-address\": \"\",\n \"template\": false,\n \"moref-

id\": \"vm-81\",\n \"vcenter-name\": \"blr76231.lss.emc.com\",\n

\"path\": \"/DC/test/Centos2\",\n \"moref-path\": \"/datacenter-

2/domain-c179/vm-81\",\n \"vm-path\": \"/DC/Centos2\",\n \"moref-

vm-path\": \"/datacenter-2/vm-81\",\n \"datastore\":

\"datastore\",\n \"datastore-moref\": \"datastore-63\",\n \"os-

identifier\": \"centos64Guest\",\n \"os-name\": \"CentOS 4/5/6/7

(64-bit)\",\n \"version\": \"vmx-08\",\n \"change-version\":

\"2018-06-04T04:22:46.608173Z\",\n \"esxi-moref\": \"host-60\",\n

\"esxi-name\": \"10.31.78.230\",\n \"datacenter\": \"datacenter-

2\",\n \"compute-resource\": \"\",\n \"cluster-compute-resource\":

\"domain-c179\",\n \"networks\": [\n \"VM Network\"\n ],\n

\"disks\": [\n {\n \"display-name\": \"Hard disk 1\",\n

\"datastore\": \"datastore\",\n \"datastore-moref\":

\"datastore-63\",\n \"disk-key\": 2000,\n \"size-kb\":

6291456,\n \"thin\": true,\n \"disk_stats\": {\n

\"Statistics\": {\n \"ProvisionedBytes\": 6442450944,\n

\"UsedBytes\": 6015221760,\n \"ChangedBytes\": 6015221760,\n

\"SecondsTaken\": 110\n },\n \"DDStatistics\": {\n

\"PreClientCompBytes\": 20258736,\n \"PostClientCompBytes\":

19087931,\n \"TotalSegments\": 714820,\n

\"RedundantSegments\": 713354\n },\n \"BaseFileName\":

\"[datastore] Centos2/Centos2.vmdk\"\n }\n }\n ]\n}" ]

}, {

"key" : "*vm_name",

"values" : [ "Centos2" ]

}, {

"key" : "*vm_uuid",

"values" : [ "503c64f8-1cef-3164-2103-b6b578d51a7a" ]

}, {

NetWorker 9.1.x REST API Reference Guide. 242

Dell Customer Communication - Confidential

"key" : "group",

"values" : [ "P5vProxy_WvProxy" ]

}, {

"key" : "saveset features",

"values" : [ "CLIENT_SAVETIME" ]

} ],

"browseTime" : "2018-09-21T00:13:41+05:30",

"clientHostname" : "blr76231.lss.emc.com",

"clientId" : "797c0f25-00000004-5b6a9dad-5b6a9dac-00015000-

b90e9956",

"completionTime" : "2018-08-20T11:08:25+05:30",

"creationTime" : "2018-08-20T11:06:24+05:30",

"fileCount" : 1,

"id" : "1d83bfb8-00000006-ff7a5358-5b7a5358-00025000-b90e9956",

"instances" : [ {

"clone" : false,

"id" : "1534743384",

"status" : "Recoverable",

"volumeIds" : [ "6550706" ]

}, {

"clone" : true,

"id" : "1534744804",

"status" : "Recoverable",

"volumeIds" : [ "4267963839" ]

} ],

"level" : "Full",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/503c64f8-1cef-3164-2103-b6b578d51a7a/backups/1d83bfb8-

00000006-ff7a5358-5b7a5358-00025000-b90e9956",

"rel" : "item"

} ],

"name" : "vm:503c64f8-1cef-3164-2103-

b6b578d51a7a:blr76231.lss.emc.com",

"retentionTime" : "2018-09-21T00:13:41+05:30",

"saveTime" : "2018-08-20T11:05:57+05:30",

"shortId" : "4286206808",

"size" : {

"unit" : "Byte",

"value" : 6448763148

},

"type" : "File",

"vmInformation" : {

"datastoreMoref" : "datastore-63",

"hostMoref" : "host-60",

"disks" : [ {

"datastoreMoref" : "datastore-63",

"datastoreName" : "datastore",

"key" : "2000",

"name" : "Hard disk 1",

NetWorker 9.1.x REST API Reference Guide. 243

Dell Customer Communication - Confidential

"sizeInKb" : 6291456,

"thinProvisioned" : false

} ],

"morefPath" : "/datacenter-2/domain-c179/vm-81",

"vCenterHostname" : "blr76231.lss.emc.com",

"vmMoref" : "vm-81",

"vmName" : "Centos2"

}

} ],

"count" : 1

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about all backups (save sets) for a specific protected VM is retrieved successfully. BackupList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/protectedvms

Returns a list of protected VMs for a specific vCenter. (getVCenterProtectedVms)

This operation can be used to retrieve a list of all the protected VMs for a specific vCenter. However, the query parameters can be used to filter the response.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

NetWorker 9.1.x REST API Reference Guide. 244

Dell Customer Communication - Confidential

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

VMwareProtectedVmList

Example data

Content-Type: application/json

{

"count" : 6,

"vms" : [ {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/500a0a4a-5438-9cda-e5f3-85601f2cee74",

"rel" : "item"

} ],

"morefId" : "vm-76",

"name" : "centos-linux-1",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "500a0a4a-5438-9cda-e5f3-85601f2cee74",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}, {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

NetWorker 9.1.x REST API Reference Guide. 245

Dell Customer Communication - Confidential

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/50157a82-24f4-9008-af54-c7f705ee5777",

"rel" : "item"

} ],

"morefId" : "vm-153",

"name" : "NewCentos_3",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "50157a82-24f4-9008-af54-c7f705ee5777",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}, {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/501580b7-6f38-22e6-bc33-a0ab4a4e2a30",

"rel" : "item"

} ],

"morefId" : "vm-124",

"name" : "Centosnew002",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "501580b7-6f38-22e6-bc33-a0ab4a4e2a30",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}, {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/5015aa02-c9c9-4f53-7eda-1ab280ae4eac",

"rel" : "item"

} ],

"morefId" : "vm-125",

"name" : "Centosnew003",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "5015aa02-c9c9-4f53-7eda-1ab280ae4eac",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}, {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

NetWorker 9.1.x REST API Reference Guide. 246

Dell Customer Communication - Confidential

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/5015e31d-0cd6-d384-0c99-3b74260bcef7",

"rel" : "item"

} ],

"morefId" : "vm-123",

"name" : "Centosnew001",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "5015e31d-0cd6-d384-0c99-3b74260bcef7",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}, {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/503c64f8-1cef-3164-2103-b6b578d51a7a",

"rel" : "item"

} ],

"morefId" : "vm-81",

"name" : "Centos2",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "503c64f8-1cef-3164-2103-b6b578d51a7a",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the protected VMs are retrieved successfully. VMwareProtectedVmList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404

NetWorker 9.1.x REST API Reference Guide. 247

Dell Customer Communication - Confidential

NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}

Returns the specific VM for a specific vCenter. (getVCenterVm)

This operation can fetch the information about the specific VM for a specific vCenter. vCenter provides a central point of control for managing, monitoring, provisioning and migrating virtual machines.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the Virtual Machine resource.

Return type

VMwareVm

Example data

Content-Type: application/json

{

"annotation" : "This is Backup and Recovery vProxy Appliance",

"connectionState" : "disconnected",

"hostname" : "",

"ipAddress" : "",

"ipAddresses" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/vms/

5007d26b-0b6a-083e-a6c0-cb7556c0a901/protectiondetails",

"title" : "List of protection details"

} ],

"morefId" : "vm-172",

"name" : "vproxy92build27_blr76248_PS_Automation",

"osId" : "sles12_64Guest",

"osName" : "SUSE Linux Enterprise 12 (64-bit)",

"powerState" : "off",

"state" : "notRunning",

"status" : "gray",

"type" : "VirtualMachine",

NetWorker 9.1.x REST API Reference Guide. 248

Dell Customer Communication - Confidential

"uuid" : "5007d26b-0b6a-083e-a6c0-cb7556c0a901",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-10"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Informaion about the specific VM is retrieved successfully. VMwareVm

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/vms

Returns a list of VMs for a specific vCenter. (getVCenterVms)

This operation can be used to obtain the information on all VMs for a specific vCenter. However, the query parameters can be used to filter the response. The vCenter provides a central point of control for managing, monitoring, provisioning and migrating virtual machines.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example,

NetWorker 9.1.x REST API Reference Guide. 249

Dell Customer Communication - Confidential

/endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

VMwareVmList

Example data

Content-Type: application/json

{

"count" : 2,

"vms" : [ {

"annotation" : "This is Backup and Recovery vProxy Appliance",

"connectionState" : "disconnected",

"hostname" : "",

"ipAddress" : "",

"ipAddresses" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/vms/

5007d26b-0b6a-083e-a6c0-cb7556c0a901",

"rel" : "item"

} ],

"morefId" : "vm-172",

"name" : "vproxy92build27_blr76248_PS_Automation",

"osId" : "sles12_64Guest",

"osName" : "SUSE Linux Enterprise 12 (64-bit)",

"powerState" : "off",

"state" : "notRunning",

"status" : "gray",

"type" : "VirtualMachine",

"uuid" : "5007d26b-0b6a-083e-a6c0-cb7556c0a901",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-10"

}, {

"annotation" : "OVA linux centos 6.3 64-bit",

"connectionState" : "disconnected",

"hostname" : "",

"ipAddress" : "",

NetWorker 9.1.x REST API Reference Guide. 250

Dell Customer Communication - Confidential

"ipAddresses" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/vms/

500a0a4a-5438-9cda-e5f3-85601f2cee74",

"rel" : "item"

} ],

"morefId" : "vm-76",

"name" : "centos-linux-1",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"powerState" : "off",

"state" : "notRunning",

"status" : "gray",

"type" : "VirtualMachine",

"uuid" : "500a0a4a-5438-9cda-e5f3-85601f2cee74",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the VMs were retrieved successfully. VMwareVmList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters

Returns a list of vCenters. (getVCenters)

This operation can be used to retrieve the information about all the vCenters. However, the query parameters can be used to filter the response.

NetWorker 9.1.x REST API Reference Guide. 251

Dell Customer Communication - Confidential

A vCenter provides a central point of control for managing, monitoring, provisioning, and migrating virtual machines in the VMware ecosystem.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

VCenterList

Example data

Content-Type: application/json

{

"count" : 1,

"vCenters" : [ {

"cloudDeployment" : false,

"hostname" : "blr76231.lss.emc.com",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com",

"rel" : "item"

} ],

"resourceId" : {

"id" : "175.0.249.58.0.0.0.0.64.243.99.91.10.31.79.40",

"sequence" : 12830

},

"userName" : "administrator@vsphere.local",

"userPassword" : "*******"

} ]

}

Produces

NetWorker 9.1.x REST API Reference Guide. 252

Dell Customer Communication - Confidential

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the vCenters are retrieved successfully. VCenterList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/protectedvms

Returns a list of protected VMs. (getVMwareProtectedVms)

This operation can be used to retrieve the information about all the protected VMs. However, the query parameters can be used to filter the response. This list may include both active and retired virtual machines. Currently active virtual machines can be listed from /vmware/vms.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

NetWorker 9.1.x REST API Reference Guide. 253

Dell Customer Communication - Confidential

Return type

VMwareProtectedVmList

Example data

Content-Type: application/json

{

"count" : 2,

"vms" : [ {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/500a0a4a-5438-9cda-e5f3-85601f2cee74",

"rel" : "item"

} ],

"morefId" : "vm-76",

"name" : "centos-linux-1",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "500a0a4a-5438-9cda-e5f3-85601f2cee74",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

}, {

"hasAppConsistencyBackup" : false,

"hostname" : "",

"ipAddress" : "",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/prot

ectedvms/50157a82-24f4-9008-af54-c7f705ee5777",

"rel" : "item"

} ],

"morefId" : "vm-153",

"name" : "NewCentos_3",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"uuid" : "50157a82-24f4-9008-af54-c7f705ee5777",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 254

Dell Customer Communication - Confidential

application/json

Responses

200 Information about the protected VMs were retrieved successfully. VMwareProtectedVmList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vcenters/{vcenter-hostname}/vms/{vm-

uuid}/protectiondetails

Returns a list of protection details for a specific vCenter VM. (getVMwareVCenterVmProtectionDetails)

This operation can be used to retrieve the list of protection details for a specific vCenter VM.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the Virtual Machine resource.

Return type

VMwareVmProtectionDetailList

Example data

Content-Type: application/json

{

"count" : 1,

"protectionDetails" : [ {

"protectionGroup" : {

"backupOptimization" : "Capacity",

"dynamicAssociation" : true,

"name" : "P5vProxy_WvProxy",

"resourceId" : {

NetWorker 9.1.x REST API Reference Guide. 255

Dell Customer Communication - Confidential

"id" :

"49.0.137.109.0.0.0.0.101.116.105.91./protectiondetails",

"sequence" : 4

},

"vmwareWorkItemExclusion" : {

"containerMorefs" : [ ],

"vCenterHostname" : "blr76231.lss.emc.com",

"vmUuids" : [ ],

"vmdks" : [ ]

},

"vmwareWorkItemSelection" : {

"containerMorefs" : [ ],

"vCenterHostname" : "blr76231.lss.emc.com",

"vmUuids" : [ "50157a82-24f4-9008-af54-c7f705ee5777" ],

"vmdks" : [ ]

},

"workItemQueries" : [ ],

"workItemSource" : "Static",

"workItemSubType" : "All",

"workItemType" : "VMware"

},

"protectionPolicy" : {

"comment" : "",

"name" : "P5vProxy",

"policyProtectionEnable" : false,

"policyProtectionPeriod" : "",

"resourceId" : {

"id" :

"47.0.137.109.0.0.0.0.101.116.105.91./protectiondetails",

"sequence" : 90

},

"summaryNotification" : {

"command" : "nsrlog -f policy_notifications.log",

"executeOn" : "Completion"

},

"workflows" : [ {

"actions" : [ {

"actionSpecificData" : {

"backup" : {

"destinationStorageNodes" : [ "nsrserverhost" ],

"retentionPeriod" : "1 Months",

"overrideRetentionPeriod" : false,

"overrideBackupSchedule" : false,

"successThreshold" : "Success",

"backupSpecificData" : {

"vmwareVProxy" : {

"destinationPool" : "bkp26",

"ddRetentionLockTime" : "",

"enableDDRetentionLock" : false

}

NetWorker 9.1.x REST API Reference Guide. 256

Dell Customer Communication - Confidential

},

"clientOverride" : "ClientCanOverride"

}

},

"comment" : "",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"concurrent" : false,

"drivenBy" : "",

"enabled" : true,

"failureImpact" : "Continue",

"hardLimit" : "00:00",

"inactivityTimeoutInMin" : 30,

"name" : "backup",

"parallelism" : 100,

"retries" : 1,

"retryDelayInSec" : 1,

"scheduleActivities" : [ "incr", "incr", "incr", "incr",

"incr", "incr", "incr" ],

"scheduleOverrides" : [ ],

"schedulePeriod" : "Week",

"softLimit" : "00:00"

}, {

"actionSpecificData" : {

"clone" : {

"destinationStorageNode" : "nsrserverhost",

"retentionPeriod" : "1 Months",

"sourceStorageNode" : "nsrserverhost",

"enableDDRetentionLock" : false,

"ddRetentionLockTime" : "",

"destinationPool" : "DDclone71",

"deleteSource" : false

}

},

"comment" : "",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"concurrent" : true,

"drivenBy" : "backup",

"enabled" : true,

"failureImpact" : "Continue",

"hardLimit" : "00:00",

"inactivityTimeoutInMin" : 30,

"name" : "clone",

"parallelism" : 0,

"retries" : 1,

NetWorker 9.1.x REST API Reference Guide. 257

Dell Customer Communication - Confidential

"retryDelayInSec" : 1,

"scheduleActivities" : [ "exec", "exec", "exec", "exec",

"exec", "exec", "exec" ],

"scheduleOverrides" : [ ],

"schedulePeriod" : "Week",

"softLimit" : "00:00"

} ],

"autoStartEnabled" : false,

"comment" : "",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"description" : "vmware-vproxy backup, expiration 1

Months;Clone to pool DDclone71, with expiration 1 Months;",

"enabled" : true,

"endTime" : "21:00",

"name" : "WvProxy",

"protectionGroups" : [ "P5vProxy_WvProxy" ],

"restartTimeWindow" : "24:00",

"startInterval" : "24:00",

"startTime" : "21:00"

} ]

},

"workflow" : {

"actions" : [ {

"actionSpecificData" : {

"backup" : {

"destinationStorageNodes" : [ "nsrserverhost" ],

"retentionPeriod" : "1 Months",

"overrideRetentionPeriod" : false,

"overrideBackupSchedule" : false,

"successThreshold" : "Success",

"backupSpecificData" : {

"vmwareVProxy" : {

"destinationPool" : "bkp26",

"ddRetentionLockTime" : "",

"enableDDRetentionLock" : false

}

},

"clientOverride" : "ClientCanOverride"

}

},

"comment" : "",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"concurrent" : false,

"drivenBy" : "",

NetWorker 9.1.x REST API Reference Guide. 258

Dell Customer Communication - Confidential

"enabled" : true,

"failureImpact" : "Continue",

"hardLimit" : "00:00",

"inactivityTimeoutInMin" : 30,

"name" : "backup",

"parallelism" : 100,

"retries" : 1,

"retryDelayInSec" : 1,

"scheduleActivities" : [ "incr", "incr", "incr", "incr",

"incr", "incr", "incr" ],

"scheduleOverrides" : [ ],

"schedulePeriod" : "Week",

"softLimit" : "00:00"

}, {

"actionSpecificData" : {

"clone" : {

"destinationStorageNode" : "nsrserverhost",

"retentionPeriod" : "1 Months",

"sourceStorageNode" : "nsrserverhost",

"enableDDRetentionLock" : false,

"ddRetentionLockTime" : "",

"destinationPool" : "DDclone71",

"deleteSource" : false

}

},

"comment" : "",

"completionNotification" : {

"command" : "",

"executeOn" : "Ignore"

},

"concurrent" : true,

"drivenBy" : "backup",

"enabled" : true,

"failureImpact" : "Continue",

"hardLimit" : "00:00",

"inactivityTimeoutInMin" : 30,

"name" : "clone",

"parallelism" : 0,

"retries" : 1,

"retryDelayInSec" : 1,

"scheduleActivities" : [ "exec", "exec", "exec", "exec",

"exec", "exec", "exec" ],

"scheduleOverrides" : [ ],

"schedulePeriod" : "Week",

"softLimit" : "00:00"

} ],

"autoStartEnabled" : false,

"comment" : "",

"completionNotification" : {

"command" : "",

NetWorker 9.1.x REST API Reference Guide. 259

Dell Customer Communication - Confidential

"executeOn" : "Ignore"

},

"description" : "vmware-vproxy backup, expiration 1

Months;Clone to pool DDclone71, with expiration 1 Months;",

"enabled" : true,

"endTime" : "21:00",

"name" : "WvProxy",

"protectionGroups" : [ "P5vProxy_WvProxy" ],

"restartTimeWindow" : "24:00",

"startInterval" : "24:00",

"startTime" : "21:00"

}

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the list of protection details for a specific vCenter's VM is retrieved successfully. VMwareVmProtectionDetailList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vms

Returns a list of active virtual machines. (getVMwareVms)

This operation can be used to retrieve the information about all the active virtual machines. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the

NetWorker 9.1.x REST API Reference Guide. 260

Dell Customer Communication - Confidential

results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

VMwareVmList

Example data

Content-Type: application/json

{

"count" : 2,

"vms" : [ {

"annotation" : "This is Backup and Recovery vProxy Appliance",

"connectionState" : "disconnected",

"hostname" : "",

"ipAddress" : "",

"ipAddresses" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/vms/

5007d26b-0b6a-083e-a6c0-cb7556c0a901",

"rel" : "item"

} ],

"morefId" : "vm-172",

"name" : "vproxy92build27_blr76248_PS_Automation",

"osId" : "sles12_64Guest",

"osName" : "SUSE Linux Enterprise 12 (64-bit)",

"powerState" : "off",

"state" : "notRunning",

"status" : "gray",

"type" : "VirtualMachine",

"uuid" : "5007d26b-0b6a-083e-a6c0-cb7556c0a901",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-10"

}, {

"annotation" : "OVA linux centos 6.3 64-bit",

"connectionState" : "disconnected",

"hostname" : "",

NetWorker 9.1.x REST API Reference Guide. 261

Dell Customer Communication - Confidential

"ipAddress" : "",

"ipAddresses" : [ ],

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vcenters/blr76231.lss.emc.com/vms/

500a0a4a-5438-9cda-e5f3-85601f2cee74",

"rel" : "item"

} ],

"morefId" : "vm-76",

"name" : "centos-linux-1",

"osId" : "centos64Guest",

"osName" : "CentOS 4/5/6/7 (64-bit)",

"powerState" : "off",

"state" : "notRunning",

"status" : "gray",

"type" : "VirtualMachine",

"uuid" : "500a0a4a-5438-9cda-e5f3-85601f2cee74",

"vCenterHostname" : "blr76231.lss.emc.com",

"version" : "vmx-08"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the Virtual Machines are retrieved successfully. VMwareVmList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vproxies

Returns a list of vProxies. (getVProxies)

This operation can be used to retrieve the information about all the vProxies. However, the query parameters can be used to filter the response.

NetWorker 9.1.x REST API Reference Guide. 262

Dell Customer Communication - Confidential

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

VProxyList

Example data

Content-Type: application/json

{

"count" : 2,

"vProxies" : [ {

"datastores" : [ ],

"enabled" : true,

"encryptNbdSessions" : false,

"hostname" : "10.63.30.89",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vproxies/10.6.89",

"rel" : "item"

} ],

"maxHotaddSessions" : 13,

"maxNbdSessions" : 13,

"password" : "*******",

"resourceId" : {

"id" : "53.0.100.15.0.0.0.0.143.124.105.90.10.63.30.91",

"sequence" : 7

},

"userName" : "admin",

"vCenterHostname" : "10.63.30.165",

"vProxyPort" : 9090,

"version" : "Release: '3.0.0-1_SNAPSHOT20180126185157',

Buildnumber: '1', Build date: '2018-01-26T18:51:57Z'"

NetWorker 9.1.x REST API Reference Guide. 263

Dell Customer Communication - Confidential

}, {

"datastores" : [ ],

"enabled" : true,

"encryptNbdSessions" : false,

"hostname" : "10.63.30.90",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/vmware/vproxies/10.6.90",

"rel" : "item"

} ],

"maxHotaddSessions" : 13,

"maxNbdSessions" : 8,

"password" : "*******",

"resourceId" : {

"id" : "51.0.68.13.0.0.0.0.18.13.116.90.10.63.30.91",

"sequence" : 1

},

"userName" : "admin",

"vCenterHostname" : "10.63.30.165",

"vProxyPort" : 9090

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the vProxies are retrieved successfully. VProxyList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /vmware/vproxies/{vproxy-hostname}

Returns the specific vProxy. (getVProxy)

This operation can be used to fetch information about the specific vProxy appliance.

NetWorker 9.1.x REST API Reference Guide. 264

Dell Customer Communication - Confidential

Path parameters

vproxy-hostname (required) Path Parameter is the value of hostname attribute in the vProxy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

VProxy

Example data

Content-Type: application/json

{

"datastores" : [ ],

"enabled" : false,

"encryptNbdSessions" : false,

"hostname" : "10.63.30.90",

"maxHotaddSessions" : 13,

"maxNbdSessions" : 13,

"password" : "*******",

"resourceId" : {

"id" : "46.0.84.7.0.0.0.0.179.242.94.90.10.207.86.34",

"sequence" : 2

},

"userName" : "admin",

"vCenterHostname" : "10.63.30.165",

"vProxyPort" : 9090

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the specific vProxy is retrieved successfully. VProxy

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500

NetWorker 9.1.x REST API Reference Guide. 265

Dell Customer Communication - Confidential

InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse

Creates a new VM browse session. (postBackupVProxyVmBrowseSessionRequest)

This operation can be used to create a new VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be created.

Example request body

Content-Type: application/json

{

"currentWorkingDirectory": "E:\\"

}

NetWorker 9.1.x REST API Reference Guide. 266

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

VProxyVmBrowseSessionPutOrPostResponse

Example data

Content-Type: application/json

{

"config" : {

"idleTimeout" : 0,

"cacheRetentionSeconds" : 6,

"sessionId" : "sessionId",

"currentWorkingDirectory" : "C:\\",

"browseDestination" : true

},

"status" : {

"description" : "description",

"state" : "state"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Browse session is created successfully. VProxyVmBrowseSessionPutOrPostResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 267

Dell Customer Communication - Confidential

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}/vmbrowse

Creates a new vmbrowse session. (postInstanceVProxyVmBrowseSessionRequest)

This operation can be used to create a new vmbrowse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be created.

Example request body

Content-Type: application/json

{

"currentWorkingDirectory": "E:\\"

}

NetWorker 9.1.x REST API Reference Guide. 268

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

VProxyVmBrowseSessionPutOrPostResponse

Example data

Content-Type: application/json

{

"config" : {

"idleTimeout" : 0,

"cacheRetentionSeconds" : 6,

"sessionId" : "sessionId",

"currentWorkingDirectory" : "C:\\",

"browseDestination" : true

},

"status" : {

"description" : "description",

"state" : "state"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Browse session is created successfully. VProxyVmBrowseSessionPutOrPostResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 269

Dell Customer Communication - Confidential

Up POST /vmware/vproxies/op/register

Create and register a vProxy. (postOpRegisterVProxy)

This operation can be used to create and register a vProxy appliance.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

VProxy VProxy (required) Body Parameter Request body to create and register a single vProxy.

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 vProxy is created successfully. The vProxy resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 270

Dell Customer Communication - Confidential

Up POST /vmware/vcenters

Creates a new vCenter. (postVCenter)

This operation can be used to create a new vCenter. vCenter provides a central point of control for managing, monitoring, provisioning, and migrating virtual machines in the VMware ecosystem.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vcenter VCenter (required) Body Parameter vCenter to be created.

Example request body

Content-Type: application/json

{

"cloudDeployment": false,

"hostname": "blr76231.lab.abc.com",

"userName": "administrator@vsphere.local",

"userPassword": "abc12Xyz"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 271

Dell Customer Communication - Confidential

201 vCenter is created successfully. The vCenter resource URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/op/refresh

Refreshes NetWorker information for the specific vCenter. (postVCenterOpRefresh)

This operation can be used to refresh the information about the specific vCenter in the NetWorker instance.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body object (optional) Body Parameter

Example request body

Content-Type: application/json

{

"currentWorkingDirectory": "E:\\"

}

NetWorker 9.1.x REST API Reference Guide. 272

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Operation started successfully. Location header contains a job URI to be monitored. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/plugins

Installs NetWorker plug-ins for the specific vCenter. (postVCenterPlugin)

This operation can be used to install NetWorker plug-ins for the specific vCenter.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

NetWorker 9.1.x REST API Reference Guide. 273

Dell Customer Communication - Confidential

Request body

vCenterPlugin VCenterPlugin (required) Body Parameter Parameters to install the plug-in.

Example request body

Content-Type: application/json

{

"pluginType": "VC",

"nwUserId": "administrator",

"nwPassword": "Changeme@123",

"httpPort": 80,

"httpsPort": 443

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

VCenterPluginResponse

Example data

Content-Type: application/json

{

"output" : {

"registered" : true

},

"resultCode" : "resultCode",

"status" : "status"

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Operation completed successfully. VCenterPluginResponse

400

NetWorker 9.1.x REST API Reference Guide. 274

Dell Customer Communication - Confidential

BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/inspectbackup

Inspect an app consistent VM backup for purposes of catalog retrieval. (postVCenterProtectedVmBackupInspectBackup)

This operation can used to inspect an app consistent VM backup for purposes of catalog retrieval.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body object (optional) Body Parameter

Example request body

Content-Type: application/json

{}

NetWorker 9.1.x REST API Reference Guide. 275

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A job corresponding to inspect operation is created. The job URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/inspectbackup

Inspect an app consistent VM backup for purposes of catalog retrieval. (postVCenterProtectedVmBackupInstanceInspectBackup)

This operation can used to inspect an app consistent VM backup for purposes of catalog retrieval.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

NetWorker 9.1.x REST API Reference Guide. 276

Dell Customer Communication - Confidential

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body object (optional) Body Parameter

Example request body

Content-Type: application/json

{}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A job corresponding to inspect operation is created. The Job URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403

NetWorker 9.1.x REST API Reference Guide. 277

Dell Customer Communication - Confidential

AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/recover

Starts a recovery of a selected protected VM backup. (postVCenterProtectedVmBackupInstanceRecover)

This operation can be used to start a recovery of a selected protected VM backup.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vmwareVmOpRecover VMwareVmOpRecover (required) Body Parameter Parameters to start the recovery.

Example request body

Content-Type: application/json

{

"recoverMode": "FLR",

"vCenterHostname": "10.207.86.28",

"mountJobId": "704689",

"vmwareVmFlrOptions": {

NetWorker 9.1.x REST API Reference Guide. 278

Dell Customer Communication - Confidential

"terminateMountSession": "false",

"overwrite": "true",

"itemsToRecover": [

"E:\\demo\\A.txt",

"E:\\demo\\B.txt"

],

"recoveryDestination": "C:\\target"

}

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Recover resource is created successfully. The recover resource URI can be found in the location header of the response. EmptyResponse

202 Accepted.

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount

Mounts a selected protected VM backup instance for purposes of FLR. (postVCenterProtectedVmBackupInstanceVmMount)

NetWorker 9.1.x REST API Reference Guide. 279

Dell Customer Communication - Confidential

This opreration can be used to mount a selected protected VM backup instance for the purpose of FLR.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

backupOpVmMount BackupOpVmMount (required) Body Parameter Parameters to start the mount.

Example request body

Content-Type: application/json

{

"installFlrAgent": true,

"targetVCenterHostname": "10.207.86.28",

"targetVmAdminUserId": "administrator",

"targetVmAdminUserPassword": "Password123!",

"targetVmMoref": "vm-108",

"targetVmName": "Win-host2",

"targetVmUserId": "administrator",

"targetVmUserPassword": "Password123!",

"uninstallFlrAgent": false,

"vProxy": "10.207.86.35"

}

NetWorker 9.1.x REST API Reference Guide. 280

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A job corresponding to mount operation is created. The Job URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/recover

Starts a recovery of a selected protected VM backup. (postVCenterProtectedVmBackupRecover)

This operation can be used to start a recovery of a selected protected VM backup.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required)

NetWorker 9.1.x REST API Reference Guide. 281

Dell Customer Communication - Confidential

Path Parameter is the value of the id attribute in the backup resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vmwareVmOpRecover VMwareVmOpRecover (required) Body Parameter Parameters to start the recovery.

Example request body

Content-Type: application/json

{

"recoverMode": "FLR",

"vCenterHostname": "10.207.86.28",

"mountJobId": "704689",

"vmwareVmFlrOptions": {

"terminateMountSession": "false",

"overwrite": "true",

"itemsToRecover": [

"E:\\demo\\A.txt",

"E:\\demo\\B.txt"

],

"recoveryDestination": "C:\\target"

}

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

NetWorker 9.1.x REST API Reference Guide. 282

Dell Customer Communication - Confidential

201 Recover resource is created successfully. The Recover resource URI can be found in the location header of the response. EmptyResponse

202 Accepted.

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount

Mounts a protected VM backup for purpose of File Level Recovery. (postVCenterProtectedVmBackupVmMount)

This operation can be used to mount a selected protected VM backup for the purpose of File Level Recovery.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

backupOpVmMount BackupOpVmMount (required) Body Parameter Parameters to start the mount.

NetWorker 9.1.x REST API Reference Guide. 283

Dell Customer Communication - Confidential

Example request body

Content-Type: application/json

{

"installFlrAgent": true,

"targetVCenterHostname": "10.207.86.28",

"targetVmAdminUserId": "administrator",

"targetVmAdminUserPassword": "Password123!",

"targetVmMoref": "vm-108",

"targetVmName": "Win-host2",

"targetVmUserId": "administrator",

"targetVmUserPassword": "Password123!",

"uninstallFlrAgent": false,

"vProxy": "10.207.86.35"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 A job corresponding to mount operation is created. The job URI can be found in the location header of the response. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 284

Dell Customer Communication - Confidential

Up POST /vmware/op/refreshvcenters

Refreshes the NetWorker information for all the vCenters. (postVMwareOpRefreshVCenters)

This operation can be used to refresh the NetWorker information for all the vCenters.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body object (optional) Body Parameter

Example request body

Content-Type: application/json

{}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Operation started successfully. Location header contains a job URI to be monitored. EmptyResponse

400 BadRequestErrorResponse

401

NetWorker 9.1.x REST API Reference Guide. 285

Dell Customer Communication - Confidential

AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500

Up POST /vmware/vcenters/{vcenter-hostname}/vms/{vm-uuid}/op/backup

Starts a backup for a specific /vms/{vm-uuid}/ vCenter VM. (postVMwareVCenterVmOpBackup)

This operation can be used to start a backup for a specific /vms/{vm-uuid}/ vCenter VM.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the Virtual Machine resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vmwareVmOpBackup VMwareVmOpBackup (required) Body Parameter Parameters to start the backup.

Example request body

Content-Type: application/json

{

"policy": "Policy_Name",

"workflow": "workflow_name"

}

NetWorker 9.1.x REST API Reference Guide. 286

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 Operation started successfully. Location header contains a job URI to be monitored. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up POST /vmware/vproxies

Create a vProxy appliance resource. (postVProxy)

This operation can be used to create a new vProxy appliance resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vproxy VProxy (required) Body Parameter The information about the vProxy to be created.

NetWorker 9.1.x REST API Reference Guide. 287

Dell Customer Communication - Confidential

Example request body

Content-Type: application/json

{

"enabled": true,

"hostname": "10.63.30.90",

"maxHotaddSessions": 13,

"maxNbdSessions": 13,

"userName": "admin",

"vCenterHostname": "10.63.30.165",

"password": "emclegato",

"vProxyPort": 9090

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201 vProxy is created successfully. The vProxy resource URI can be found in the location header of the response. EmptyResponse

202 Accepted.

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 288

Dell Customer Communication - Confidential

Up PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/op/vmmount/{vproxy-mount-session-

id}/vmbrowse/{vproxy-browse-session-id}

Updates the specific VM browse session. (putBackupVProxyVmBrowseSessionRequest)

This operation can be used to update the attributes of the specific VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be updated.

Example request body

Content-Type: application/json

{

"currentWorkingDirectory": "E:\\"

}

NetWorker 9.1.x REST API Reference Guide. 289

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

VProxyVmBrowseSessionPutOrPostResponse

Example data

Content-Type: application/json

{

"config" : {

"idleTimeout" : 0,

"cacheRetentionSeconds" : 6,

"sessionId" : "sessionId",

"currentWorkingDirectory" : "C:\\",

"browseDestination" : true

},

"status" : {

"description" : "description",

"state" : "state"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 VM browse session attributes were updated successfully. VProxyVmBrowseSessionPutOrPostResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 290

Dell Customer Communication - Confidential

Up PUT /vmware/vcenters/{vcenter-hostname}/protectedvms/{vm-

uuid}/backups/{backup-id}/instances/{instance-id}/op/vmmount/{vproxy-

mount-session-id}/vmbrowse/{vproxy-browse-session-id}

Updates the specific VM browse session. (putInstanceVProxyVmBrowseSessionRequest)

This operation can be used to update the attributes of specific VM browse session.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

vm-uuid (required) Path Parameter is the value of the uuid attribute in the protected Virtual Machine resource.

backup-id (required) Path Parameter is the value of the id attribute in the backup resource.

instance-id (required) Path Parameter is the value of the id attribute in the instance resource.

vproxy-mount-session-id (required) Path Parameter is the value of the vProxyMountSessionId attribute in the vproxy VM mount job resource.

vproxy-browse-session-id (required) Path Parameter is the value of the sessionId attribute of the session's config resource.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

VProxyVmBrowseSessionRequest VProxyVmBrowseSessionRequest (required) Body Parameter The vmbrowse session details to be updated.

Example request body

Content-Type: application/json

{

"currentWorkingDirectory": "E:\\"

}

NetWorker 9.1.x REST API Reference Guide. 291

Dell Customer Communication - Confidential

Request headers: This header must specify the content type of

request payload as application/json.

Return type

VProxyVmBrowseSessionPutOrPostResponse

Example data

Content-Type: application/json

{

"config" : {

"idleTimeout" : 0,

"cacheRetentionSeconds" : 6,

"sessionId" : "sessionId",

"currentWorkingDirectory" : "C:\\",

"browseDestination" : true

},

"status" : {

"description" : "description",

"state" : "state"

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202 VM browse session attributes updated successfully. VProxyVmBrowseSessionPutOrPostResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

NetWorker 9.1.x REST API Reference Guide. 292

Dell Customer Communication - Confidential

Up PUT /vmware/vcenters/{vcenter-hostname}

Updates the specific vCenter. (putVCenter)

This operation can be used to modify the attributes of a specific vCenter.

Path parameters

vcenter-hostname (required) Path Parameter is the value of the hostname attribute in the vCenter resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vcenter VCenter (required) Body Parameter vCenter to modify.

Example request body

Content-Type: application/json

{

"cloudDeployment": false,

"hostname": "blr76231.lab.abc.com",

"userName": "administrator@vsphere.local",

"userPassword": "xyzAbc"

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

NetWorker 9.1.x REST API Reference Guide. 293

Dell Customer Communication - Confidential

application/json

Responses

204 vCenter attributes are updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up PUT /vmware/vproxies/{vproxy-hostname}

Updates the specific vProxy appliance. (putVProxy)

This operation can be used to update the attributes of a specific vProxy.

Path parameters

vproxy-hostname (required) Path Parameter is the value of hostname attribute in the vProxy resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

vproxy VProxy (required) Body Parameter vProxy to modify.

Example request body

Content-Type: application/json

{

"enabled": false,

NetWorker 9.1.x REST API Reference Guide. 294

Dell Customer Communication - Confidential

"hostname": "10.63.30.90",

"maxHotaddSessions": 20,

"maxNbdSessions": 20,

"userName": "admin",

"vCenterHostname": "10.63.30.165",

"password": "emclegato",

"vProxyPort": 9090

}

Request headers: This header must specify the content type of

request payload as application/json.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 VProxy resource is updated successfully. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Volumes

Up DELETE /volumes/{volumeId}

Deletes the specific volume. (deleteVolume)

This operation can be used to delete a specific volume from NetWorker.

NetWorker 9.1.x REST API Reference Guide. 295

Dell Customer Communication - Confidential

Path parameters

volumeId (required) Path Parameter is the value of the name attribute in the volume resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

EmptyResponse

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204 Volume is deleted successfully from NetWorker. EmptyResponse

400 BadRequestErrorResponse

401 AuthNErrorResponse

403 AuthZErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Up GET /volumes/{volumeId}

Returns the specific volume. (getVolume)

This operation can be used to fetch the information about the specific volume.

Path parameters

volumeId (required) Path Parameter is the value of the name attribute in the volume resource. Note: URL encoding or Percent encoding need to be used to build the resource identifier from the name.

Return type

Volume

NetWorker 9.1.x REST API Reference Guide. 296

Dell Customer Communication - Confidential

Example data

Content-Type: application/json

{

"accessTime" : "2018-10-23T05:07:58-04:00",

"availabilityFlags" : [ ],

"expirationTime" : "2020-10-22T05:07:58-04:00",

"family" : "disk",

"flags" : [ ],

"id" : "3654214894",

"latestLabelTime" : "2018-10-23T05:07:58-04:00",

"links" : [ ],

"location" : "10.31.196.90",

"mounts" : 0,

"name" : "bob_restapi.dddefault.001",

"originalLabelTime" : "2018-10-23T05:07:58-04:00",

"pool" : "Data Domain Default",

"recover" : {

"unit" : "KB",

"value" : 0

},

"recycled" : 0,

"states" : [ ],

"type" : "Data Domain",

"written" : {

"unit" : "KB",

"value" : 0

}

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Volume information is retrieved successfully. Volume

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500

NetWorker 9.1.x REST API Reference Guide. 297

Dell Customer Communication - Confidential

InternalServerErrorResponse

Up GET /volumes

Returns a list of volumes. (getVolumes)

This operation can be used to retrieve the information about all the volumes. However, the query parameters can be used to filter the response.

Query parameters

q (optional) Query Parameter The parameter "q" represents the Query filter. Use this parameter to specify an "attribute matching a value" on which to filter the results. Only exact match of the entered value is supported. For example, /endpoint?q=AttributeName:Value filters the result to resources with AttributeName=Value. To specify multiple values, use the "and" delimiter, for example, /endpoint?q=AttributeName1:Value1 and AttributeName2:Value2.

fl (optional) Query Parameter The parameter "fl" represents the Field List filter. Use this parameter to specify the fields (or attributes) to be shown in the response, as in fl=field1,field2. This parameter setting helps to limit the information in the response. If not specified, all the fields are shown. To use query filter (q) and field list filter (fl) concurrently, separate both filters with the "&" delimiter, as in /endpoint?q=AttributeName1:Value & fl=AttributeName2.

Return type

VolumeList

Example data

Content-Type: application/json

{

"count" : 2,

"volumes" : [ {

"accessTime" : "2018-10-23T05:07:58-04:00",

"availabilityFlags" : [ ],

"expirationTime" : "2020-10-22T05:07:58-04:00",

"family" : "disk",

"flags" : [ ],

"id" : "3654214894",

"latestLabelTime" : "2018-10-23T05:07:58-04:00",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/volumes/3654214894",

"rel" : "item"

} ],

NetWorker 9.1.x REST API Reference Guide. 298

Dell Customer Communication - Confidential

"location" : "10.31.196.90",

"mounts" : 0,

"name" : "bob_restapi.dddefault.001",

"originalLabelTime" : "2018-10-23T05:07:58-04:00",

"pool" : "Data Domain Default",

"recover" : {

"unit" : "KB",

"value" : 0

},

"recycled" : 0,

"states" : [ ],

"type" : "Data Domain",

"written" : {

"unit" : "KB",

"value" : 0

}

}, {

"accessTime" : "2018-10-23T01:50:59-04:00",

"availabilityFlags" : [ ],

"expirationTime" : "2020-10-17T04:25:44-04:00",

"family" : "disk",

"flags" : [ ],

"id" : "13124488",

"latestLabelTime" : "2018-10-18T04:25:44-04:00",

"links" : [ {

"href" : "https://networker-

ip:9090/nwrestapi/v3/global/volumes/13124488",

"rel" : "item"

} ],

"mounts" : 0,

"name" : "bob_restapi.001",

"originalLabelTime" : "2018-10-18T04:25:44-04:00",

"pool" : "Default",

"recover" : {

"unit" : "KB",

"value" : 0

},

"recycled" : 0,

"saveSetExpirationTime" : "2018-11-23T23:59:59-05:00",

"saveSetIds" : [ "3670980291", "3687757507", "3704534702",

"3805155411", "3821932627", "3838695408", "4291314674" ],

"states" : [ ],

"type" : "adv_file",

"written" : {

"unit" : "KB",

"value" : 228040

}

} ]

}

NetWorker 9.1.x REST API Reference Guide. 299

Dell Customer Communication - Confidential

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200 Information about the volumes are retrieved successfully. VolumeList

400 BadRequestErrorResponse

401 AuthNErrorResponse

404 NotFoundErrorResponse

500 InternalServerErrorResponse

Models

[ Jump to Methods ]

Table of Contents

1. Alert -

2. AlertList -

3. AssociatedPolicy -

4. AssociatedPolicyList -

5. Attr -

6. AuditLogConfiguration -

7. AuthNErrorResponse -

8. AuthZErrorResponse -

9. Backup -

10. BackupInstance -

11. BackupInstanceList -

12. BackupList -

13. BackupOpVmMount -

14. BadRequestErrorResponse -

15. BitRate -

16. Client -

17. ClientList -

18. ClientOpBackup -

NetWorker 9.1.x REST API Reference Guide. 300

Dell Customer Communication - Confidential

19. CloudboostAppliance -

20. CloudboostApplianceList -

21. DataDomainSystem -

22. DataDomainSystemList -

23. Device -

24. DeviceList -

25. DeviceOpLabel -

26. DeviceOpMount -

27. DeviceOpStatus -

28. Directive -

29. DirectiveList -

30. EBRSession -

31. EmptyResponse - Empty response payload.

32. HttpHeader -

33. HttpRequest -

34. HttpStatus -

35. Index -

36. IndexList -

37. InfoResponse - Information about the response.

38. InternalServerErrorResponse -

39. Job -

40. JobIndication -

41. JobIndicationList -

42. JobList -

43. JobOpCancel -

44. Label -

45. LabelList -

46. License -

47. LicenseList -

48. Link -

49. NASDevice -

50. NASDeviceList -

51. NotFoundErrorResponse -

52. Notification -

53. NotificationList -

54. Policy -

55. PolicyAction -

56. PolicyActionBackup -

57. PolicyActionBackupSnapshot -

58. PolicyActionBackupSpecificData -

59. PolicyActionBackupTraditional -

60. PolicyActionBackupVMwareVProxy -

61. PolicyActionBackupVMwareVba -

62. PolicyActionCheckConnectivity -

63. PolicyActionClone -

64. PolicyActionDiscover -

NetWorker 9.1.x REST API Reference Guide. 301

Dell Customer Communication - Confidential

65. PolicyActionExpire -

66. PolicyActionGenerateIndex -

67. PolicyActionProbe -

68. PolicyActionServerBackup -

69. PolicyActionSettingOverride -

70. PolicyActionSpecificData -

71. PolicyActionVbaCheckpointBackup -

72. PolicyActionVbaCheckpointDiscover -

73. PolicyActionWorkItemFilter -

74. PolicyList -

75. PolicyNotification -

76. PolicyWorkflow -

77. PolicyWorkflowList -

78. PolicyWorkflowOpBackup -

79. Pool -

80. PoolList -

81. Probe -

82. ProbeList -

83. ProtectionGroup -

84. ProtectionGroupList -

85. Recover -

86. RecoverBackupInstance -

87. RecoverList -

88. RecoverNDMPOptions -

89. ResourceId -

90. Rule -

91. RuleItemDefinition -

92. RuleList -

93. ServerConfiguration -

94. ServerMessage -

95. ServerMessageList -

96. ServerStatistics -

97. Session -

98. SessionList -

99. Size -

100. StorageNode -

101. StorageNodeList -

102. Tenant -

103. TenantList -

104. TimeStampBasedGranularRecover -

105. UserGroup -

106. UserGroupList -

107. VCenter -

108. VCenterList -

109. VCenterPlugin -

110. VCenterPluginResponse -

NetWorker 9.1.x REST API Reference Guide. 302

Dell Customer Communication - Confidential

111. VMwareApplicationRecoverSavesetInfo -

112. VMwareProtectedVm -

113. VMwareProtectedVmList -

114. VMwareVm -

115. VMwareVmBackupInfo -

116. VMwareVmEmergencyRecoverCleanupOptions -

117. VMwareVmFlrOptions -

118. VMwareVmGuestInfo -

119. VMwareVmList -

120. VMwareVmOpBackup -

121. VMwareVmOpRecover -

122. VMwareVmProtectionDetail -

123. VMwareVmProtectionDetailList -

124. VMwareVmdkBackupInfo -

125. VMwareVmdkRecoverInfo -

126. VMwareVmdkWorkItem -

127. VMwareWorkItemOpUpdate -

128. VMwareWorkItemSelection -

129. VProxy -

130. VProxyList -

131. VProxyVmBrowseSessionPutOrPostResponse -

132. VProxyVmBrowseSessionRequest -

133. VProxyVmBrowseSessionResponse -

134. VProxyVmBrowseSessionResponseConfig -

135. VProxyVmBrowseSessionResponseList -

136. VProxyVmBrowseSessionResponseStatus -

137. VProxyVmMountSessionResponse -

138. VProxyVmMountSessionResponseConfig -

139. VProxyVmMountSessionResponseStatus -

140. Volume -

141. VolumeList -

142. XmlError -

143. XmlFile -

144. XmlVmBrowseDirectoryContents -

Alert - Up

category (optional) String This attribute specifies the category of the alert. message (optional) String This attribute describes the error condition in the system. priority (optional) String This attribute specifies the priority of the alert. timestamp (optional) Date This attribute specifies the timestamp of the alert. format: date-time

AlertList - Up

NetWorker 9.1.x REST API Reference Guide. 303

Dell Customer Communication - Confidential

count (optional) Integer This attribute specifies the number of alerts. format: int32 alerts (optional) array[Alert] This attribute contains information about the alerts. links (optional) array[Link]

AssociatedPolicy - Up

policy (optional) String This attribute specifies the name of the policy. workflow (optional) String This attribute specifies the name of workflow. action (optional) String This attribute specifies the name of action.

AssociatedPolicyList - Up

count (optional) Integer This attribute specifies the number of policies associated with a schedule. format: int32 associations (optional) array[AssociatedPolicy] This attribute contains information about the policies, workflows and actions associated with a schedule. links (optional) array[Link]

Attr - Up

key (optional) String values (optional) array[String]

AuditLogConfiguration - Up

administrators (optional) array[String] This attribute specifies the list of user/administrator allowed to administer. auditLogFilePath (optional) String This attribute specifies the security audit file location. auditLogHostname (optional) String This attribute specifies the hostname of the logging server. By default, it runs on the NetWorker server. auditLogMaxFileSizeInMB (optional) Integer This attribute specifies he maximum size of the log file in MB. When this maximum is reached, the file is renamed for archival purposes and the default name is used to create a new security audit log file. format: int32 auditLogMaxFileVersion (optional)

NetWorker 9.1.x REST API Reference Guide. 304

Dell Customer Communication - Confidential

Integer This attribute specifies the number of versions of the log files to keep during rollover before they are deleted. Use zero to maintain all the versions. format: int32 auditLogRenderedLocale (optional) String This attribute specifies the locale, or language, of the rendered security audit log file. By default, the en_US locale is used. auditLogRenderedService (optional) String This attribute specifies the service used for logging the rendered messages.

Enum: None Local Syslog Eventlog

auditLogSeverity (optional) String This attribute specifies the level of logging detail that each client provides to the security audit log server. By default, it is set to error. When the level is set to information, information level and higher security related events are recorded in the security audit log file.

Enum: Information Notice Warning Error Severe Critical

name (optional) String This attribute specifies the name of the file where security related audit messages are logged. This is a read-only attribute. resourceId (optional) ResourceId

AuthNErrorResponse - Up

Authentication failed due to invalid authentication credentials. Authentication information is missing or invalid. Authorization header must be set with a value that starts with 'Basic' followed by a space and a base64- encoded 'username:password' string. message (optional) String This attribute describes the error scenario. status (optional) HttpStatus timestamp (optional) Date This attribute specifies the timestamp of the error. format: date-time userAgentRequest (optional) HttpRequest version (optional)

NetWorker 9.1.x REST API Reference Guide. 305

Dell Customer Communication - Confidential

String This attribute specifies the version of the NetWorker server.

AuthZErrorResponse - Up

Authorization failed due to inadequate privileges for the NetWorker user to perform the specific operation. Ensure that the authenticating user to the NetWorker API service has the appropriate User Group privileges to perform this operation. message (optional) String This attribute describes the error scenario. status (optional) HttpStatus timestamp (optional) Date This attribute specifies the timestamp of the error. format: date-time userAgentRequest (optional) HttpRequest version (optional) String This attribute specifies the version of the NetWorker server.

Backup - Up

attributes (optional) array[Attr] browseTime (optional) Date This attribute specifies the save set's browse time in the time and date format. This is the time limit that the save set will remain browsable. format: date-time clientHostname (optional) String clientId (optional) String The client id is used to identify a save set with a specific client. Each client has a unique client id which is automatically generated by the NetWorker server. completionTime (optional) Date This attribute specifies the save set's completion time. This is the time the save set backup was completed. format: date-time creationTime (optional) Date This attribute specifies the creation time on the server. If the client and server clocks are out of sync, this time may be different from the save time. format: date-time fileCount (optional) Long format: int64 id (optional) String The attribute specifies the backup id. instances (optional) array[BackupInstance] level (optional)

NetWorker 9.1.x REST API Reference Guide. 306

Dell Customer Communication - Confidential

String This attribute specifies the backup level. Different levels enable you to trade off the number of volumes and amount of time required to complete a backup.

Enum: 1 2 3 4 5 6 7 8 9 Consolidate Full Incr IncrSynthFull Manual Migration Skip SynthFull TxnLog

links (optional) array[Link] name (optional) String retentionTime (optional) Date This attribute specifies the save set's retention time (expiration time) in the time and date format. This is the time limit that the save set will remain recoverable in the media database. format: date-time saveTime (optional) Date This attribute specifies the save time on the client. format: date-time shortId (optional) String size (optional) Size tenant (optional) String This attribute specifies the name of the restricted data zone (RDZ) to which the backup belongs. type (optional) String This attribute specifies the type of the backup.

Enum: CoverSet DSA File NDMP Raw Snapshot

NetWorker 9.1.x REST API Reference Guide. 307

Dell Customer Communication - Confidential

Unknown vmInformation (optional) VMwareVmBackupInfo

BackupInstance - Up

clone (optional) Boolean This attribute indicates whether or not this backup instance represents a clone. id (optional) String This attribute specifies the ID of the backup instance. links (optional) array[Link] status (optional) String This attribute specifies the status of the backup instance.

Enum: Aborted Browsable InProgress Recoverable Recyclable Unknown

volumeIds (optional) array[String] This attribute specifies the associated volume IDs.

BackupInstanceList - Up

backupInstances (optional) array[BackupInstance] This attribute contains information about the backup instances. count (optional) Integer This attribute specifies the number of backup instances. format: int32 links (optional) array[Link]

BackupList - Up

backups (optional) array[Backup] This attribute contains the information about the backups. count (optional) Integer This attribute specifies the number of backups. format: int32 links (optional) array[Link]

BackupOpVmMount - Up

backupDeviceExportPath (optional) String This attribute specifies the export path for the device. installFlrAgent (optional)

NetWorker 9.1.x REST API Reference Guide. 308

Dell Customer Communication - Confidential

Boolean targetVCenterHostname (optional) String This attribute specifies the hostname of target vCenter. targetVmAdminUserId (optional) String This attribute specifies the administrator user ID of target VM. targetVmAdminUserPassword (optional) String This attribute specifies the administrator user password of target VM. targetVmMoref (optional) String This attribute specifies the target VM moref. targetVmName (optional) String This attribute specifies the target VM name. targetVmUserId (optional) String This attribute specifies the user ID of target VM. targetVmUserPassword (optional) String This attribute specifies the user password of target VM. uninstallFlrAgent (optional) Boolean vProxy (optional) String This attribute specifies the IP address of vProxy appliance.

BadRequestErrorResponse - Up

The server could not process the request due to something that is perceived to be a client error. Request is either not well-formed, syntactically incorrect, or found to be invalid in the specific context. The most common causes include: * The payload is not specified in the request or a mandatory field is missing. * An unrecognized field is referenced in the payload or Query, possibly due to violation of case convention. * The payload is not as per data format defined in the NetWorker API specification. * Validation check failed, although request is found to be syntactically correct. For example, the DNS resolution check fails, if specified hostname cannot be resolved. message (optional) String This attribute describes the error scenario. status (optional) HttpStatus timestamp (optional) Date This attribute specifies the timestamp of the error. format: date-time userAgentRequest (optional) HttpRequest version (optional) String This attribute specifies the version of the NetWorker server.

BitRate - Up

NetWorker 9.1.x REST API Reference Guide. 309

Dell Customer Communication - Confidential

unit (optional) String This attribute specifies the unit of bit rate.

Enum: Byte/s KB/s

value (optional) Long format: int64

Client - Up

aliases (optional) array[String] This attribute specifies aliases for the client machine that queries can match. If this list is empty, match on client name alone. applicationInformation (optional) array[String] 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. These options are application specific and are documented in the respective application user guides. archiveservicesEnabled (optional) Boolean This attribute determines whether archive services are available for the client. autoSelectStorageNodeEnabled (optional) Boolean This attribute specifies whether the client can override the attributes of the backup target disks, storage nodes, and recover storage nodes. backupCommand (optional) String This attribute specifies the remote command to run to back up data for this client and save sets. The value must not include the path to the command. You can specify the command with specific options, for example, send verbose backup information. Alternately you can customize the backups by creating additional programs (scripts) that affect the way the NetWorker server backs up the data as in pre and post backup processing. The program must start with the prefix 'save' or 'nsr' and must be placed in the bin directory of the NetWorker installation directory on the NetWorker client. backupRenamedDirectoriesEnabled (optional) Boolean This attribute specifies whether to include renamed directories in an incremental backup. However, the renamed directory must be explicitly listed in the save set attribute. By default, if the name of a directory changes after a full backup, but no files or subfolders in the directory change, NetWorker will not include the renamed directory in subsequent incremental backups.

NetWorker 9.1.x REST API Reference Guide. 310

Dell Customer Communication - Confidential

backupTargetDisks (optional) array[String] This is an ordered list of disk devices for the client to use when saving the data, without refering to the storage node lists. The devices can be either advanced file type or Data Domain devices. This attribute does not apply to the client of the NetWorker server. backupType (optional) String This attribute specifies the client backup type as "FileSystem", "vProxy", "SQL Server", "Microsoft Exchange Server " etc. blockBasedBackup (optional) Boolean Select this attribute to enable the image backups. Refer to the NetWorker Administration Guide for additional information about configuring block based backups. centralizedLogsCollection (optional) Boolean This attribute enables or disables local logs collections into the centralized logs storage for this client. By default, it is enabled. checkPointGranularity (optional) String This attribute specifies whether to restart the backup from the point of failure at the directory or file level. The defualt value is Directory. 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. 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.

Enum: Directory File

checkpointEnabled (optional) Boolean This attribute enables the support for checkpoint restart during scheduled backups. The save program performs a backup in an ordered manner and keeps track of the files saved. If save fails, it can be restarted from the point of interruption (file or directory). The ordering of the filesystems during backup may cause performance impact. clientId (optional) String This attribute specifies the client's identifier and cannot be changed. clientDirectEnabled (optional) Boolean This attribute indicates if this client is enabled to bypass the storage node and write directly to the target disk device during a scheduled backup of the client. comment (optional) String This attribute specifies any user-defined description of this client or other explanatory remarks. dataDomainBackup (optional) Boolean This attribute specifies whether the backup destination for this client is a Data Domain device. dataDomainInterface (optional)

NetWorker 9.1.x REST API Reference Guide. 311

Dell Customer Communication - Confidential

String This attribute specifies the client interface over which a Client Direct backup to a Data Domain device should occur. The default value is IP. This attribute has meaning only when the Data Domain Backup and Client Direct attributes are enabled.

Enum: Any IP Fibre Channel

directive (optional) 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. executablePath (optional) String This attribute specifies the path to the NetWorker executables on this client. fileInactivityAlertThreshold (optional) Integer This attribute specifies the percentage of space occupied by inactive files. When the value exceeds, it generates a notification. A value of zero indicates that no alert is sent to this client. fileInactivityThreshold (optional) 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. hostname (optional) String This attribute specifies the hostname of the NetWorker client. indexBackupContent (optional) Boolean This attribute specifies index files and directories on the snapshot. indexPath (optional) String This attribute is used to allow the NetWorker administrator to balance NetWorker online file index disk utilization across multiple disk partitions. If set, this attribute contains the full path to the directory containing the clients online file index. jobControl (optional) array[String] This attribute is intended to be used with custom backup scripts. It controls how savegrp and nsrjobd interpret the end of a job and its status. links (optional) array[Link] nasDevice (optional) Boolean This attribute specifies whether this client is a NAS device. nasDeviceManagementName (optional) String In NAS device configurations, this attribute specifies the management name of the device. nasFileAccessPassword (optional) String This password is used to access the file services on a NAS device. If a password is specified, then the NAS file server user attribute for the client resource must also be defined. Each instance of a client can have a different password. This field is only used with Windows clients. This field is ignored with other client types. nasFileAccessUser (optional)

NetWorker 9.1.x REST API Reference Guide. 312

Dell Customer Communication - Confidential

String This user accesses the file services on a NAS device. Each instance of a client can have a different value for the NAS management user. This field is only used with Windows clients. This field is ignored with other client types. nasManagementPassword (optional) String This password is used to perform management actions on a NAS device. If a password is given, then the ''NAS management user'' attribute for the client resource must also be defined. Each instance of a client can have a different password. nasManagementUser (optional) String The user as which to run remote management commands on this NAS device. Each instance of a client can have a different value for the ''NAS management user''. ndmp (optional) Boolean This attribute indicates whether the client is a NDMP client. ndmpArrayName (optional) String In NDMP NAS array configurations, the logical name assigned to the array. ndmpMultiStreamsEnabled (optional) Boolean ndmpLogSuccessfulFileRecov (optional) Boolean This attributes specifies whether the logging shows the recovered files in the log file. ndmpVendorInformation (optional) array[String] networkerVersion (optional) String This attribute contains the NetWorker version that is running on the client machine. By default, this field is blank. This attribute is updated when the backup is performed. ownerNotification (optional) String This attribute specifies a notification action to send the contents of status messages to the owner/primary user of a client (e.g. savegrp completion messages). parallelSaveStreamsPerSaveSet (optional) Boolean This attribute specifies whether to enable Parallel Save Streams(PSS). Enabling PSS results in significant performance improvements due to save set aggregation. parallelism (optional) Integer This attribute specifies the number of data streams that a client can use simultaneously during backup. format: int32 password (optional) String The commands save and savefs use the password to gain access to the files being backed up, and other backup commands may use it to access application data. If a password is given, then the remote user attribute for the client resource must also be defined. This attribute is not used for UNIX file system clients. Each instance of a client can have a different password. physicalClientParallelismEnabled (optional) Boolean This attribute specifies whether to override the client parallelism and use the physical client's parallelism. physicalHost (optional)

NetWorker 9.1.x REST API Reference Guide. 313

Dell Customer Communication - Confidential

String This attribute specifies the physical hostname, if this resource is for a virtual client. The hostname does not not need to be fully qualified, but must be less than 64 bytes. All clients that share the same physical host must use the same name. Do not mix the name formats, such as short, FQDN, and IP address. pool (optional) String This attribute specifies the media pool used for data target selection during a scheduled backup of the save sets specified in this client. postCommand (optional) String The command that is specified here runs after the save sets are completed for this client. The value must not include a path and must start with the prefix 'save' or 'nsr'. preCommand (optional) String The command that is specified here runs before the save sets for this client. The value must not include a path and must start with the prefix 'save' or 'nsr'. prepolicyGroup (optional) array[String] This attribute specifies the list of groups of which the client was a member before the policy was upgraded. priority (optional) 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. probeResourceName (optional) String This attribute specifies the probe resource name, so that probe is initiated against the NetWorker client before the backup begins. protectionGroups (optional) array[String] recoverStorageNodes (optional) array[String] This attribute is an ordered list of storage nodes for the client to use when recovering its data. remoteAccessUsers (optional) array[String] A list of remote users that are allowed to recover this client's files. If empty, only users logged into this machine are valid. Examples: sam@jupiter or user=sam,host=jupiter (user sam on machine jupiter), group=wheel,host=jupiter (any user in group wheel on host jupiter), jupiter or host=jupiter (any user on machine jupiter). Warning: If using the restricted data zones (RDZ)s feature it is possible to give access to someone not explicitly in the associated restricted data zone (RDZ). Use caution with wildcard characters. remoteUser (optional) String The user that runs remote commands on this client or accesses the application-specific data. Each instance of a client can have a different value for the 'remote user'. resourceId (optional) ResourceId retentionPolicy (optional) String This attribute specifies the name of the policy controlling how long entries will remain in the media index before they are marked as recyclable.

NetWorker 9.1.x REST API Reference Guide. 314

Dell Customer Communication - Confidential

saveOperations (optional) String This attribute specifies the save operation instructions in the format: KEYWORD:TOKEN=STATE[;KEYWORD:TOKEN=STATE;...]. This attribute is required if save set attribute of this client contains non-ASCII names. This attribute can also be used to configure VSS saves on the Windows OS. saveSessionDistribution (optional) String This attribute sets the threshold for the save session distribution. The client will distribute the save sessions to the next storage node in the storage node affinity list when the overall target sessions or max sessions of all devices on the current storage node is exceeded. The default threshold is max sessions.

Enum: MaxSessions TargetSessions

saveSetMbt (optional) array[String] This attribute specifies the multi-byte transform of the save set names defined for the client. The multi-byte transform is a UTF-8 encoding used to preserve pathnames. saveSets (optional) array[String] A list of the save sets to be backed up for this client with this schedule. schedule (optional) String This attribute specifies the backup schedule for client resource. scheduledBackup (optional) Boolean This attribute indicates if this client is enabled for scheduled backups. shortFilenamesEnabled (optional) Boolean This attribute determines the status of the short filename processing on the Windows client. serverNetworkInterface (optional) String This attribute specifies the name of the network interface on the server to be used for saves and recoveries. storageNodes (optional) array[String] This attribute specifies an ordered list of storage nodes for the client to use when saving its data. storageReplicationPolicyName (optional) String The storage replication policy used during backup. tags (optional) array[String] This attribute contains tags for the clients. tenant (optional) String The restricted data zone (RDZ) this resource belongs to if it belongs to one. vbaHostType (optional) String This attribute specifies whether the client is for VBA server or proxy host.

Enum: VBA Server Host VBA Proxy Host

virtualClient (optional) Boolean This attribute indicates whether the client is a virtual machine.

NetWorker 9.1.x REST API Reference Guide. 315

Dell Customer Communication - Confidential

ClientList - Up

clients (optional) array[Client] This attribute specifies the information about the clients. count (optional) Integer This attribute specifies the number of clients. format: int32 links (optional) array[Link]

ClientOpBackup - Up

actionOverrides (optional) array[PolicyActionSettingOverride] policy (optional) String This attribute specifies the policy name. workflow (optional) String This attribute specifies the workflow name.

CloudboostAppliance - Up

host (optional) String This attribute specifies the hostname of cloudboost appliance. name (optional) String This attribute specifies the name of cloudboost appliance. username (optional) String This attribute specifies the username used to connect to the cloudboost appliance. password (optional) String This attribute specifies the password used to connect to the cloudboost appliance. resourceId (optional) ResourceId

CloudboostApplianceList - Up

count (optional) Integer This attribute specifies the number of cloudboost appliances. format: int32 cloudBoostAppliances (optional) array[CloudboostAppliance] This attribute contains information corresponding to cloudboost appliances.

DataDomainSystem - Up

availableCapacity (optional) String This attribute specifies the Data Domain available capacity. cloudUnit (optional) String The cloud unit for the associated MTree. comment (optional)

NetWorker 9.1.x REST API Reference Guide. 316

Dell Customer Communication - Confidential

String Any user-defined description of this resource or other explanatory remarks. exportPath (optional) String Export path specifies the path relative to a base path that has been NFS exported by the Data Domain, for example, 7678/exported-dir. The base path is the path to the directory that contains the Data Domain MTree, for example, /data/col1. fcHostName (optional) String This attribute specifies the Data Domain system Fibre Channel hostname. hosts (optional) String This attribute specifies the list of all the hosts on a Data Domain system. inuseFilecopyStreams (optional) String This attribute specifies the Data Domain in-use filecopy streams. inuseReadStreams (optional) String This attribute specifies the Data Domain in-use read streams. inuseReadWriteStreams (optional) String This attribute specifies the Data Domain in-use read/write streams. inuseReplicationStreams (optional) String This attribute specifies the Data Domain in-use replication streams. managementCertificate (optional) String This attribute specifies the certificate that the REST API uses to manage the Data Domain system. managementHost (optional) String This attribute specifies the Data Domain management host. managementPort (optional) String This attribute specifies the remote port that the REST API uses to manage the Data Domain system. managementUser (optional) String This attribute specifies the remote username with administrative privileges to manage the Data Domain system. maxReadStreams (optional) String This attribute specifies the Data Domain maximum read streams. maxWriteStreams (optional) String This attribute specifies the Data Domain maximum write streams. maxReplicationDestinationStreams (optional) String This attribute specifies the Data Domain maximum replication destination streams. maxReplicationSourceStreams (optional) String This attribute specifies the Data Domain maximum replication source streams. model (optional) String This attribute specifies the Data Domain model. name (optional) String This attribute specifies the Data Domain system name as a unique string. osVersion (optional) String This attribute specifies the Data Domain OS version. serial (optional) String This attribute specifies the Data Domain serial number.

NetWorker 9.1.x REST API Reference Guide. 317

Dell Customer Communication - Confidential

snmpCommunityString (optional) String This attribute specifies the Data Domain SNMP community string. storageNode (optional) String This attribute specifies the storage node to connect to Data Domain system. totalCapacity (optional) String This attribute specifies the Data Domain total capacity. totalMaxStreams (optional) String This attribute specifies the Data Domain total maximum streams. totalMaxWriteStreams (optional) String This attribute specifies the Data Domain total maximum write streams. usedCapacity (optional) String This attribute specifies the Data Domain used capacity. usedLogicalCapacity (optional) String This attribute specifies the Data Domain used logical capacity. userName (optional) String This attribute specifies the remote username to connect to the Data Domain system.

DataDomainSystemList - Up

count (optional) Integer This attribute specifies the number of Data Domain systems. format: int32 dataDomainSystems (optional) array[DataDomainSystem] This attribute specifies the information about the Data Domain systems. links (optional) array[Link]

Device - Up

autoMediaManagement (optional) Boolean This attribute enables automated media management for volumes loaded into the device. This includes automatic mounting of NetWorker volumes loaded into the device, automatic labeling of blank volumes loaded into the device, and automatic recycling of eligible volumes loaded into the device. cdi (optional) String This attribute indicates whether or not to use the Common Device Interface (CDI) for this device. To enable TapeAlert, which provides diagnostic information for devices, you must select SCSI commands.

Enum: NotUsed SCSI

cleaningInterval (optional)

NetWorker 9.1.x REST API Reference Guide. 318

Dell Customer Communication - Confidential

String This attribute indicates the period of time from when the device was last cleaned until the next scheduled cleaning. The time may be specified in days, weeks, or months. For example: 4 days, 2 weeks, month (same as 1 month). cleaningRequired (optional) Boolean This attribute indicates whether the media device needs to be cleaned. cloudBandwidthThrottlingSettings (optional) array[String] This attribute specifies the maximum internet bandwidth that a cloud backup or recovery operation can consume at any given time of the day or week. cloudBandwithThrottlingEnabled (optional) Boolean This attribute specifies whether or not cloud bandwidth throttling is enabled. cloudCACertificate (optional) String This attribute specifies the CA Certificate of the cloud store. cloudCompression (optional) String This attribute specifies the cloud compression type from the predefined list.

Enum: None SpeedVerySlow SpeedSlow SpeedMedium SpeedFast

cloudEncryption (optional) String This attribute specifies the encryption algorithm from the predefined list.

Enum: None AES256

cloudNetworkFailureRetryInMin (optional) Integer This attribute specifies the number of minutes that a backup or recover session must wait before a failed network connection results in an aborted backup or recover session. format: int32 cloudNumberOfRetries (optional) Integer This attribute specifies the number of times that NetWorker must attempt to send back up data or receive recover data in the event of a network failure. format: int32 cloudServer (optional) String This attribute specifies the IP address or fully qualified domain name of the cloud server. cloudTimeout (optional) Integer This attribute specifies the number of seconds that NetWorker will wait for confirmation that network send and receive transmissions to the cloud server have occurred successfully. Note: If the timeout period expires, the data transmission is considered to have failed. format: int32 cloudWriteSizeInKB (optional)

NetWorker 9.1.x REST API Reference Guide. 319

Dell Customer Communication - Confidential

Integer This attribute specifies the amount of backup data in kilobytes to cache in memory before sending to the cloud. format: int32 comment (optional) String This attribute specifies a user-defined description of this device or other explanatory remarks. dataDomainFibreChannel (optional) Boolean This attribute enables Fibre Channel access for Data Domain devices. Note: This attribute is supported only for a Data Domain device. dataDomainFibreChannelHostname (optional) String This attribute specifies pseudo hostname of the Fibre Channel enabled Data Domain server. Note: This attribute is supported only for a Data Domain device. dataDomainHost (optional) String This attribute specifies the hostname for the Data Domain appliance associated with this device. Note: This attribute is supported only for a Data Domain device. dataDomainRetentionLockMode (optional) String This attribute enables or disables the Data Domain retention lock. Note: This attribute is supported only for a Data Domain device.

Enum: None Governance Compliance

dataDomainRetentionLockPeriodMin (optional) String This attribute specifies the minimum retention period for the Data Domain device. The value range is 12 hours to 70 years. The correct format is XX days HH:MM:SS. Note: This attribute is supported only for a Data Domain device. dataDomainRetentionLockPeriodMax (optional) String This attribute specifies the maximum retention period for the Data Domain device. The value range is 12 hours to 70 years. The correct format is XX days HH:MM:SS. Note: This attribute is supported only for a Data Domain device. dateLastCleaned (optional) Date This attribute specifies the last date when the media device was cleaned. format: date-time description (optional) String This attribute specifies the description of the device. deviceAccessInfo (optional) String This attribute specifies the access path for an advance file or a Data Domain device. deviceSerialNumber (optional) String This attribute specifies the serial number of the device. dltWormCapable (optional) Boolean This attribute specifies whether the device is capable of creating DLTWORM media. hardwareId (optional) String This attribute specifies the ID of a shared drive, where the physical drive can be accessed from multiple device paths. links (optional)

NetWorker 9.1.x REST API Reference Guide. 320

Dell Customer Communication - Confidential

array[Link] maxNsrmmdCount (optional) Integer This attribute specifies the maximum number of nsrmmd processes started for this device. format: int32 maxSession (optional) Integer This attribute specifies the maximum number of save sessions for the device. format: int32 mediaFamily (optional) String The general class of storage media is determined automatically from the type of the device.

Enum: Tape Disk Cloud Logical

mediaType (optional) String The media type describes the actual storage media from the predefined list. This is a mandatory attribute.

Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C T10000B T10000 9940B 9940 9840D

NetWorker 9.1.x REST API Reference Guide. 321

Dell Customer Communication - Confidential

9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2

NetWorker 9.1.x REST API Reference Guide. 322

Dell Customer Communication - Confidential

SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt

message (optional) String The NetWorker server uses this attribute to store I18N messages regarding this device. mountedVolume (optional) String This attribute specifies the name of the volume mounted on this device. name (optional) String

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 infomation" attribute to specify a path.

. Note: You cannot change the name after the device is created. If needed, delete the device and create a new device. ndmp (optional) Boolean This attribute identifies the device as an NDMP device. parentJukebox (optional) String This attribute contains the name of the jukebox to which this device belongs. password (optional)

NetWorker 9.1.x REST API Reference Guide. 323

Dell Customer Communication - Confidential

String This attribute specifies the password associated with the remote user. The password is used to connect to the NDMP tape server, Data Domain server, or the UNC adv_file device path on a network drive or a CloudBoost device. pathId (optional) String This attribute represents the ID of a shared disk directory, where the directory can be accessed from multiple device paths. readOnly (optional) Boolean This attribute specifies whether the device is available for read-only operations. remoteUser (optional) String This attribute specifies the user that is used to connect to the NDMP tape server, Data Domain server, or the UNC or NFS adv_file device path on a network drive. For CloudBoost devices, the value is the 'token-id' or 'access key' supplied by the CloudBoost vendor. resourceId (optional) ResourceId status (optional) String This attribute specifies whether the device is available for use.

Enum: Enabled Disabled Service

suspectedDevice (optional) Boolean This attribute specifies whether the device lost connection on storage node. tapeAlertsWarning (optional) array[String] This attribute specifies a message when the media or device needs servicing. tapeAlertsCritical (optional) array[String] This attribute specifies critical diagnostic information, such as for media or drive failure, when user intervention is urgent and data is at risk. tapeAlertsInformation (optional) array[String] This attribute indicates the information on the device status. Note: For TapeAlert capability, set the CDI attribute to 'SCSI'. targetSession (optional) Integer This attribute specifies the number of save sessions dispatched to this device before another device is considered. format: int32 tenant (optional) String This attribute specifies the name of the restricted data zone (RDZ) to which this device belongs. verifyLabelOnEject (optional) Boolean Enabling this attribute causes automatic verification of the label whenever the media is ejected. volumeId (optional) String This attribute specifies the volume ID for the currently mounted volume. volumePool (optional) String This attribute specifies specifies the pool to which the current volume belongs.

NetWorker 9.1.x REST API Reference Guide. 324

Dell Customer Communication - Confidential

warnOnSuspectVolumesInPercent (optional) Integer 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. format: int32 wormCapable (optional) Boolean This attribute specifies whether the device is capable of handling WORM media. wormCartridgePresent (optional) Boolean This attribute specifies whether the volume currently loaded in the drive (if any) is a WORM cartridge. This attribute is set automatically based on information retrieved from the tape drive. writeEnabled (optional) Boolean This attribute specifies whether the device is enabled for write.

DeviceList - Up

count (optional) Integer This attribute specifies the number of devices. format: int32 devices (optional) array[Device] This attribute specifies the information about the devices. links (optional) array[Link]

DeviceOpLabel - Up

capacity (optional) String This attribute can be used to specify the new capacity of the device. labelWithoutMount (optional) Boolean This attribute can be used to label the device without mount. manualRecycleOnly (optional) Boolean This attribute can be used to enable manual recycling. Note: When a volume is marked as manual recycle, the assigned browse and retention policies are disregarded. pool (optional) String This attribute can be used to specify a different pool to change the volume pool assignment. relabel (optional) Boolean This attribute can be used to relabel the volume. Note: When 'relabel' is enabled, do not set 'pool', 'verifyUnlabeledVolume', or 'volumeLabel'. verifyUnlabeledVolume (optional) Boolean This attribute can be used to set or unset the unlabeled volume verification. volumeLabel (optional) String This attribute specifies a new unique volume label.

DeviceOpMount - Up

NetWorker 9.1.x REST API Reference Guide. 325

Dell Customer Communication - Confidential

volume (optional) String This attribute specifies the volume to mount. writeEnabled (optional) Boolean This attribute specifies whether the device is enabled for write.

DeviceOpStatus - Up

error (optional) String This attribute shows any error messages on the device. message (optional) String This attribute shows any informational messages on the device. operation (optional) String This attribute shows the operational state of the device.

Enum: Unmount Mount VerifyLabel Label LabelWithoutMount Eject VerifyWriteTime MonitorDevice RecoverSpace CheckFileSystem Check Erase CheckMedia

operationInProgress (optional) Boolean This attribute shows whether an operation is in progress on the device. resourceId (optional) ResourceId volumeLabel (optional) String This attribute shows the volume label.

Directive - Up

Directives can be used to improve the efficiency of backups by controlling which files get saved and specifying special handling on certain types of files. comment (optional) String This attribute is provided for the administrator to keep any explanatory remarks or supplementary information about the directive. directive (optional) String This attribute contains the rules defining the directive. The value of this attribute is similar to the contents of a .nsr file except that absolute path names must be specified for each << pa th >> directive. See nsr(5) for more information on the format of this attribute. links (optional) array[Link]

NetWorker 9.1.x REST API Reference Guide. 326

Dell Customer Communication - Confidential

name (optional) String This attribute specifies the name of the directive. resourceId (optional) ResourceId tenant (optional) String This attribute specifies the tenant name for the identity provider configuration in the Net- Worker Authentication Service database.

DirectiveList - Up

count (optional) Integer This attribute specifies the number of directives. format: int32 directives (optional) array[Directive] This attribute contains the information about the directives. links (optional) array[Link]

EBRSession - Up

registered (optional) Boolean This attribute specifies the registration status of the EMC Backup and Recovery (EBR) plug-in.

EmptyResponse - Empty response payload. Up

This entity represents an empty response payload.

HttpHeader - Up

A HTTP header specifies the required information about the request or response, or about the payload. name (optional) String This attribute specifies the HTTP header key. value (optional) String This attribute specifies the HTTP header value.

HttpRequest - Up

contentLength (optional) Long This attribute specifies the size of the request body. format: int64 headers (optional) array[HttpHeader] This attribute specifies the HTTP headers. method (optional) String This attribute specifies the HTTP method used. query (optional) String This attribute specifies the query parameters used in the associated URL. url (optional) String This attribute specifies the associated URL.

NetWorker 9.1.x REST API Reference Guide. 327

Dell Customer Communication - Confidential

HttpStatus - Up

code (optional) Integer This attribute specifies the HTTP status code. format: int32 codeClass (optional) String This attribute specifies the code class. reasonPhrase (optional) String This attribute specifies the cause.

Index - Up

Client file index stores information about each file backed up by a NetWorker client. clientFileId (optional) String This attribute specifies the client file ID fileName (optional) String This attribute specifies the name of the file. fileSizeInBytes (optional) Long This attribute specifies the file size in bytes. format: int64 namespace (optional) String This attribute specifies the associated namespace.

Enum: backup migrated archive nsr ccmail informix msexch msmail mssql notes sapmssql saporacle saphana sybase db2 mysql oracle nmcasa actdir medi MOSS bbb nmm nmm_bbb msapp_pp msapp_bbb

NetWorker 9.1.x REST API Reference Guide. 328

Dell Customer Communication - Confidential

fsagent fsagent_scan iq msvmapp

offset (optional) Long This attribute specifies the offset. format: int64 saveTime (optional) String This attribute specifies save time in UTC format.

IndexList - Up

count (optional) Integer This attribute specifies the number of indexes. format: int32 items (optional) array[Index]

InfoResponse - Information about the response. Up

Informational response. text (optional) String This attribute specifies an informational message.

InternalServerErrorResponse - Up

An internal application error prevented the server from fulfilling the request, possibly due to an unexpected condition during the task execution or communication failure with an internal component. message (optional) String This attribute describes the error scenario. status (optional) HttpStatus timestamp (optional) Date This attribute specifies the timestamp of the error. format: date-time userAgentRequest (optional) HttpRequest version (optional) String This attribute specifies the version of the NetWorker server.

Job - Up

adhocJob (optional) Boolean This attribute specifies whether this job is an adhoc job. Adhoc job is a manual job initiated by the user, which is not initiated by jobd. clientHostname (optional) String This attribute specifies the NetWorker client name or ID. command (optional) String This attribute specifies the command string used to start this job. completionStatus (optional) String This attribute specifies the completion status of this job.

NetWorker 9.1.x REST API Reference Guide. 329

Dell Customer Communication - Confidential

Enum: Unknown CommunicationLost NeverStarted DidNotRun Succeeded Failed Cancelled Abandoned MissedTheSchedule

dataSize (optional) Size This attribute specifies the amount of data in kilobytes saved or recovered by this job. dependentJobIds (optional) array[Long] This attribute specifies the IDs of dependents of this job. format: int64 endTime (optional) Date This attribute specifies the date and time when this job is completed. format: date-time exitCode (optional) Long This attribute specifies the exit code of the exited job. format: int64 id (optional) Long This attribute specifies the unique ID of this job. format: int64 itemCount (optional) Long This attribute specifies the number of files saved or recovered by this job. format: int64 itemIdLong (optional) Integer links (optional) array[Link] logFile (optional) String This attribute specifies the log file of this job. message (optional) String This attribute specifies the output summary for savegrp spawned jobs. name (optional) String This attribute specifies the name of this job. ndmp (optional) Boolean This attribute indicates whether the job is related to NDMP. parentJobId (optional) Long This attribute specifies the ID of parent of this job. format: int64 previousJobId (optional) Long This attribute specifies the previous ID of this job if this is a restarted job. If the job is not restarted, the attribute specifies the value 0. format: int64 progress (optional) String This attribute specifies the activity progress summary as total/successful/failed. recoverAppItemStatus (optional) String This attribute specifies the status of recover app item.

NetWorker 9.1.x REST API Reference Guide. 330

Dell Customer Communication - Confidential

rootParentJobId (optional) Long This attribute specifies the ID of root parent of this job. format: int64 runOnHost (optional) String This attribute specifies the name of the machine on which to start this job. saveSetId (optional) String This attribute specifies the save set ID for this job. siblingJobIds (optional) array[Long] This attribute specifies the IDs of siblings of this job. The expansion job expands the job into several smaller jobs called siblings. format: int64 startTime (optional) Date This attribute specifies the date and time when this job was started. format: date-time state (optional) String This attribute specifies the current (or last known) state of this job.

Enum: Unknown Created Queued Started Active SessionActive Cancelled Completed

stopped (optional) Boolean This attribute specifies whether the job is completed or cancelled. tenant (optional) String This attribute specifies the restricted data zone to which this resource belongs. terminationReason (optional) String This attribute specifies the reason for terminating this job. type (optional) String This attribute specifies the type of job. missedClients (optional) array[String] This attribute specifies the list of missed clients during backup. disabledClients (optional) array[String] This attribute specifies the list of clients that were disabled in this group run. completionReport (optional) String This attribute specifies the completion report of this job. vProxyErrorMessages (optional) array[String] This attribute specifies the list of errors and messages from vProxy. vProxyFlrAgentInstallRequired (optional) Boolean This attribute indicates whether a mount state target VM installation is required. vProxyHostname (optional) String This attribute specifies the vProxy hostname.

NetWorker 9.1.x REST API Reference Guide. 331

Dell Customer Communication - Confidential

vProxyMountSessionId (optional) String This attribute specifies the vProxy mount session ID. vProxyMountState (optional) String This attribute specifies the vProxy mount state. vProxyMountTargetVmInvalidAdminUser (optional) Boolean vProxyMountTargetVmInvalidUser (optional) Boolean vProxyMountTargetVmMoref (optional) String This attribute specifies the target VM Management Object Reference ID. vProxyMountTargetVmName (optional) String This attribute specifies the target VM name. vProxyMountTargetVmUserId (optional) String This attribute specifies the target VM user ID. vProxyMountVCenterHostname (optional) String This attribute specifies the vCenter hostname. vProxyInspectDescriptor (optional) String This attribute specifies the inspect backup descriptor. vProxyRecoverSessionId (optional) String This attribute specifies the FLR recover session ID.

JobIndication - Up

catalogId (optional) String This attribute specifies the job indication catalog identifier. jobId (optional) Long This attribute specifies the job ID of the job that generated this indication. format: int64 links (optional) array[Link] message (optional) String This attribute specifies the message string (translated at source). messageCatalogNumber (optional) String This attribute specifies the message catalog number. messageId (optional) String This attribute specifies the message ID (unique identifier). originComponent (optional) String This attribute specifies the tag of the NetWorker component that generated this indication, such as save or nsrclone. severity (optional) String This attribute specifies the severity of this indication.

Enum: Invalid Debug Information Notice Warning Intervention

NetWorker 9.1.x REST API Reference Guide. 332

Dell Customer Communication - Confidential

Error Severe Critical Alert Emergency

tenant (optional) String This attribute specifies the restricted data zone to which this resource belongs. timestamp (optional) Date This attribute specifies the time at which this indication was received. format: date-time

JobIndicationList - Up

count (optional) Integer This attribute specifies the number of job indications. format: int32 jobIndications (optional) array[JobIndication] links (optional) array[Link]

JobList - Up

count (optional) Integer This attribute specifies the number of jobs. format: int32 jobs (optional) array[Job] links (optional) array[Link]

JobOpCancel - Up

reason (optional) String This attribute specifies the reason for terminating this job. timeoutInSec (optional) Integer This attribute specifies the timeout in seconds. format: int32

Label - Up

This resource describes the templates used to generate volume labels. comment (optional) String This attribute is provided for the administrator to keep any explanatory remarks or supplementary information about the label. fields (optional) array[String] This attribute specifies the constituent fields of a label template links (optional) array[Link] name (optional)

NetWorker 9.1.x REST API Reference Guide. 333

Dell Customer Communication - Confidential

String This attribute specifies the name of this label template. The label template is referred to by its name in the jukebox resource next (optional) String This attribute specifies the next volume name to use. After it is assigned to a volume, the next volume name will be generated and remembered here. The attribute consists of a component for each of the specified fields and the separator. resourceId (optional) ResourceId separator (optional) String This attribute specifies the character to use to separate the label fields.

Enum: . _ : -

tenant (optional) String This attribute specifies the name of the restricted data zone (RDZ) to which the label belongs.

LabelList - Up

count (optional) Integer This attribute specifies the number of labels. format: int32 labels (optional) array[Label] links (optional) array[Link]

License - Up

name (optional) String This attribute specifies the name of the license. comment (optional) String This attribute specifies the comment for the license. enablerCode (optional) String This attribute specifies an enabler code which is a unique code that activates the software. This is also called an enabler key or license enabler. hostId (optional) String This attribute specifies the host identifier of the license. expirationDate (optional) String This attribute specifies the expiration date of the license. authCode (optional) String This attribute specifies the authorization code, which is a unique code that operates with an associated enabler code. This code is used to unlock the software for permanent use on a specific host computer. licenseType (optional) String This attribute specifies the type of the license.

NetWorker 9.1.x REST API Reference Guide. 334

Dell Customer Communication - Confidential

resourceId (optional) ResourceId

LicenseList - Up

count (optional) Integer This attribute specifies the number of licenses. format: int32 licenses (optional) array[License] links (optional) array[Link]

Link - Up

This entity links a completed call with a subsequent call and hence makes the API explorable. href (optional) String This attribute contains the fully qualified URL, to use in combination with the HTTP method. Use the method POST, if the URL ends with a pattern /op/. Otherwise, the default method is GET. id (optional) String This attribute specifies the ID of the link. ID is an optional attribute. rel (optional) String This attribute specifies the link relation, which allows the user agent to understand the meaning of the available state transitions in a REST system.

Enum: create-form item related

title (optional) String This attribute describes this link. It can serve as a means to navigate to a related resource or to perform an action on this resource.

NASDevice - Up

comment (optional) String This attribute specifies a user-defined description of this NAS device or other explanatory remarks. links (optional) array[Link] name (optional) String This attribute specifies the name of the NAS device. Note: You cannot change the name after the NAS device is created. If needed, delete the NAS device and create a new NAS device. nasDeviceManagementName (optional) String This attribute specifies the management name of the NAS device. nasManagementPassword (optional) String This password is used to perform management actions on a NAS device.

NetWorker 9.1.x REST API Reference Guide. 335

Dell Customer Communication - Confidential

nasManagementUser (optional) String This user is used to perform management actions on a NAS device. resourceId (optional) ResourceId

NASDeviceList - Up

count (optional) Integer This attribute specifies the number of NAS devices. format: int32 nasDevices (optional) array[NASDevice] This attribute contains the information about the NAS devices. links (optional) array[Link]

NotFoundErrorResponse - Up

The server did not find the resource that matches the requested URI. Either the URI is incorrect or the resource is not available anymore. message (optional) String This attribute describes the error scenario. status (optional) HttpStatus timestamp (optional) Date This attribute specifies the timestamp of the error. format: date-time userAgentRequest (optional) HttpRequest version (optional) String This attribute specifies the version of the NetWorker server.

Notification - Up

action (optional) String This attribute specifies the command to be run in response to a class of events and priorities defined in this notification. additionalEmailRecipient (optional) String This attribute specifies one or more email addresses of the intended recipients to be posted on occurrence of the events defined in the notification. Use a comma to separate multiple email addresses. comment (optional) String This attribute specifies the user-defined description or other explanatory remarks. enabled (optional) Boolean This attribute indicates whether an email is sent to Dell EMC Customer Support on occurrence of the events defined in the notification. This attribute applies only to mail home notifications. events (optional) array[String] This attribute specifies the class of events for which the defined action is taken. More than one class may be specified.

NetWorker 9.1.x REST API Reference Guide. 336

Dell Customer Communication - Confidential

Enum: links (optional) array[Link] name (optional) String This attribute specifies the name of the notification assigned by the administrator. priorities (optional) array[String] This attribute specifies the priorities for taking action. More than one priority may be specified.

Enum: resourceId (optional) ResourceId

NotificationList - Up

count (optional) Integer This attribute specifies the number of notifications. format: int32 links (optional) array[Link] notifications (optional) array[Notification] This attribute contains information about the notifications.

Policy - Up

allowManualSaves (optional) Boolean applyEntireWorkflow (optional) Boolean comment (optional) String A user-specified description of this data protection policy. links (optional) array[Link] name (optional) String This attribute specifies the name of the data protection policy. resourceId (optional) ResourceId summaryNotification (optional) PolicyNotification policyProtectionEnable (optional) Boolean policyProtectionPeriod (optional) String tenant (optional) String This attribute specifies the tenant name for the identity provider configuration in the NetWorker Authentication Service database. Use this argument in multi-tenant configurations to identify the tenant hierarchy from which NetWorker Authentication Service should select the specified domain to

NetWorker 9.1.x REST API Reference Guide. 337

Dell Customer Communication - Confidential

verify the user credentials. When you omit the tenant name, NetWorker Authentication Service uses the default tenant hierarchy. workflows (optional) array[PolicyWorkflow] This attribute specifies one or more workflows. Each workflow contains a sequence of actions that NetWorker uses to protect the data.

PolicyAction - Up

Policy actions are the physical units executing the underlying operations, such as probe, backup, and clone. actionReferSchedule(optional) String This attribute specifies the name of the schedule. actionSpecificData (optional) PolicyActionSpecificData actionStartTime (optional) String This attribute specifies the start time of the action in the format hh:mm or +hh:mm, where hh:mm is the absolute time and defines when the action will start. +hh:mm is the relative time and indicates that the action will start in hh hours and mm minutes after the start of the workflow. comment (optional) String This attribute specifies the user-specified description or other explanatory remarks. completionNotification (optional) PolicyNotification concurrent (optional) Boolean This attribute specifies if the action is concurrent. customTags (optional) array[String] This attribute specifies the custom tags. drivenBy (optional) String This attribute specifies the action that drives this action. disableActionStartTime (optional) Boolean This attribute specifies the disablement of action start time. enabled (optional) Boolean This attribute indicates whether the action is enabled. failureImpact (optional) String This attribute specifies what to do when an action fails. The value can be continue, abort workflow, or abort action.

Enum: Continue AbortAction AbortWorkflow

hardLimit (optional) String Specifies the hours and minutes after the action starts to begin terminating all activities. inactivityTimeoutInMin (optional) Integer This attribute specifies how long an action remains inactive in minutes before terminating itself. format: int32

NetWorker 9.1.x REST API Reference Guide. 338

Dell Customer Communication - Confidential

name (optional) String This attribute specifies the action name. newName (optional) String This attribute specifies the new name for the action. parallelism (optional) Integer This attribute specifies how many concurrent activities an action can undertake. format: int32 retries (optional) Integer This attribute specifies how many times the action can retry. format: int32 retryDelayInSec (optional) Integer This attribute specifies how long to delay in seconds before retrying after a failure. format: int32 scheduleActivities (optional) array[String] This attribute specifies action schedule, as an array of items that may include full, incr, incr_synth_full, txnlog (logs only), exec, or skip. scheduleComment (optional) String This attribute specifies the comment on the schedule. scheduleOverrides (optional) array[String] This attribute specifies the action schedule override. Multiple action day pairs. schedulePeriod (optional) String This attribute specifies length of the schedule period for this action's schedule. The period can be "week" or "month".

Enum: Week Month

softLimit (optional) String This attribute specifies the hours and minutes after the action starts, to prevent the starting of new activities. workItemFilter (optional) PolicyActionWorkItemFilter

PolicyActionBackup - Up

backupSpecificData (optional) PolicyActionBackupSpecificData clientOverride (optional) String This attribute specifies the client override behavior from the predefined list.

Enum: ClientCanNotOverride ClientCanOverride LegacyBackupRules

destinationStorageNodes (optional) array[String] This attribute specifies the destination storage node name. overrideBackupSchedule (optional) Boolean This attribute specifies whether to override backup schedule.

NetWorker 9.1.x REST API Reference Guide. 339

Dell Customer Communication - Confidential

overrideRetentionPeriod (optional) Boolean This attribute specifies whether to override backup retention period. retentionPeriod (optional) String This attribute specifies the retention period of the backup data. successThreshold (optional) String This attribute specifies the backup action child success/failure level to its failure number.

Enum: Warning Success

PolicyActionBackupSnapshot - Up

destinationPool (optional) String This attribute specifies the name of the destination pool. forceBackupLevel (optional) String This attribute specifies the backup level. minimumRetentionPeriod (optional) String This attribute specifies the minimum retention period of a backup.

PolicyActionBackupSpecificData - Up

One and only one of those properties can be present at any time snapshot (optional) PolicyActionBackupSnapshot traditional (optional) PolicyActionBackupTraditional vmware (optional) PolicyActionBackupVMwareVba vmwareVProxy (optional) PolicyActionBackupVMwareVProxy

PolicyActionBackupTraditional - Up

enableDDRetentionLock (optional) Boolean This attribute specifies whether to enable Data Domain retention lock. Retention locking prevents any modification or deletion of files under retention from occurring directly on Data Domain share(s) during the retention period time. ddRetentionLockTime (optional) String This attribute specifies Data Domain retention lock time. This attribute is applicable if Data Domain retention lock is enabled. destinationPool (optional) String This attribute specifies the name of the destination pool. estimate (optional) Boolean This attribute specifies whether an estimate is given for the amount of data which will be generated by each save set before performing the backup. forceBackupLevel (optional)

NetWorker 9.1.x REST API Reference Guide. 340

Dell Customer Communication - Confidential

String This attribute specifies the backup level. fileInactivityAlertThresholdPercentage (optional) Integer This attribute specifies the file inactivity threshold percentage. format: int32 fileInactivityThresholdInDays (optional) Integer This attribute specifies the file inactivity threshold in days. format: int32 revertToFullWhenSyntheticFullFails (optional) Boolean This attribute specifies whether a failed synthetic full backup reverts to a regular full backup. timestampFormat (optional) String This attribute specifies the timestamp format.

Enum: None ISO Unix

verifySyntheticFull (optional) Boolean This attribute specifies whether synthetic full backups are verified.

PolicyActionBackupVMwareVProxy - Up

destinationPool (optional) String proxyName (optional) String This attribute specifies the name of a vProxy for the VMware backup to use. appConsistentQuiesce (optional) String This attribute can be used to enable the quiesce mode.

Enum: Basic Advanced None

transactionLogBackup (optional) Boolean quiesceTimeoutInMinutes (optional) Integer This attribute specifies the timeout in minutes for quiescing. quiesceSystemAdminUsername (optional) String This attribute specifies the quiesce system administrator user. quiesceSystemAdminPassword (optional) String This attribute specifies the quiesce system administrator password. enableDDRetentionLock (optional) Boolean This attribute specifies whether to enable Data Domain retention lock. Retention locking prevents any modification or deletion of files under retention from occurring directly on Data Domain share(s) during the retention period time. ddRetentionLockTime (optional) String This attribute specifies Data Domain retention lock time. This attribute is applicable if Data Domain retention lock is enabled.

NetWorker 9.1.x REST API Reference Guide. 341

Dell Customer Communication - Confidential

PolicyActionBackupVMwareVba - Up

destinationPool (optional) String saveType (optional) String PolicyVbaSaveType

Enum: VMDK VirtualMachine

useVbaInternalStorage (optional) Boolean vbaName (optional) String This attribute specifies the name of a VBA for the VMware backup to use.

PolicyActionCheckConnectivity - Up

checkAllClientsConnectvityEnabled (optional) Boolean This attribute specifies connectivity options. Set this attribute to true if the connectivity action is successful when the all the client connectivity checks succeed. Set this attribute to false if the connectivity action is successful when one or more client connectivity checks succeed.

PolicyActionClone - Up

enableDDRetentionLock (optional) Boolean This attribute specifies whether to enable Data Domain retention lock. Retention locking prevents any modification or deletion of files under retention from occurring directly on Data Domain share(s) during the retention period time. ddRetentionLockTime (optional) String This attribute specifies Data Domain retention lock time. This attribute is applicable if Data Domain retention lock is enabled. deleteSource (optional) Boolean This attribute specifies whether the source must be deleted. destinationPool (optional) String This attribute specifies the name of the destination pool. destinationStorageNode (optional) String This attribute specifies the destination storage node name. retentionPeriod (optional) String This attribute specifies the backup retention period in a format understood by nsr_getdate. sourceStorageNode (optional) String This attribute specifies the storage node name.

PolicyActionDiscover - Up

discoverType (optional) String This attribute specifies the discover type.

Enum:

NetWorker 9.1.x REST API Reference Guide. 342

Dell Customer Communication - Confidential

NAS snapshot

PolicyActionExpire - Up

PolicyActionGenerateIndex - Up

generateIndexType (optional) String This attribute specifies the index type.

Enum: NAS snapshot

PolicyActionProbe - Up

allProbsMustSucceed (optional) Boolean This attribute specifies whether or not all probes must succeed. maxBackupIntervalInDays (optional) Integer This attribute specifies the maximum backup internal in days. format: int32

PolicyActionServerBackup - Up

destinationPool (optional) String This attribute specifies the destination pool. destinationStorageNode (optional) String This attribute specifies the destination storage node. performBootstrap (optional) Boolean This attribute specifies whether to perform bootstrap. performClientFileIndexing (optional) Boolean This attribute specifies whether to perform client file indexing. retentionPeriod (optional) String This attribute specifies the retention period of the backup data. enableDDRetentionLock (optional) Boolean ddRetentionLockTime (optional) String

PolicyActionSettingOverride - Up

This attribute specifies the override attribute values to run the action. action String This attribute specifies the action. commandLineArguments String This attribute specifies the command line arguments.

PolicyActionSpecificData - Up

One and only one of those properties can be present at any time backup (optional)

NetWorker 9.1.x REST API Reference Guide. 343

Dell Customer Communication - Confidential

PolicyActionBackup testConnectivity (optional) PolicyActionCheckConnectivity clone (optional) PolicyActionClone discover (optional) PolicyActionDiscover expire (optional) PolicyActionExpire generateIndex (optional) PolicyActionGenerateIndex probe (optional) PolicyActionProbe serverBackup (optional) PolicyActionServerBackup vbaCheckpointBackup (optional) PolicyActionVbaCheckpointBackup vbaCheckpointDiscover (optional) PolicyActionVbaCheckpointDiscover

PolicyActionVbaCheckpointBackup - Up

destinationPool (optional) String retentionPeriod (optional) String This attribute specifies the retention period of the backup data.

PolicyActionVbaCheckpointDiscover - Up

PolicyActionWorkItemFilter - Up

clients (optional) array[String] This attribute contains the list of clients. levels (optional) array[String] This attribute contains the list of backup levels. saveSetTypes (optional) array[String] This attribute contains the list of save set types. timeRangeEnd (optional) Date This attribute specifies end time. format: date-time timeRangeStart (optional) Date This attribute specifies start time. format: date-time excludeClient (optional) String This attribute specifies the save set eligibility criteria to be based on the defined clients.

Enum: true false

NetWorker 9.1.x REST API Reference Guide. 344

Dell Customer Communication - Confidential

none excludeLevel (optional) String This attribute specifies the save set eligibility criteria to be based on the defined levels.

Enum: true false none

excludeTimeRange (optional) String This attribute specifies the save set eligibility criteria to be based on the defined time range.

Enum: true false none

excludeSaveSetType (optional) String This attribute specifies the save set eligibility criteria to be based on the defined save set types.

Enum: true false none

PolicyList - Up

count (optional) Integer This attribute specifies the number of policies. format: int32 links (optional) array[Link] protectionPolicies (optional) array[Policy] This attribute contains information about a list of policies.

PolicyNotification - Up

command (optional) String This attribute specifies the command to be executed. executeOn (optional) String This attribute specifies the trigger point for the notification.

Enum: Completion Failure Ignore

PolicyWorkflow - Up

Workflow specifies how the backup or restore activity is controlled. The activity can include putting the application in backup mode, deciding which data is backed up at what time, and so on. Workflow is composed of a sequence of

NetWorker 9.1.x REST API Reference Guide. 345

Dell Customer Communication - Confidential

actions, which are physical units that perform underlying operations, such as probe, backup, and clone. actions (optional) array[PolicyAction] Workflow is composed of a sequence of actions. autoStartEnabled (optional) Boolean This attribute specifies if the workflow starts automatically. comment (optional) String This attribute adds the user comment on the workflow. completionNotification (optional) PolicyNotification description (optional) String This attribute specifies the workflow description. enabled (optional) Boolean This attribute specifies if the workflow is enabled. endTime (optional) String This attribute specifies the end time of the workflow operation. links (optional) array[Link] name (optional) String This attribute specifies the current workflow name under the policy. newName (optional) String This attribute specifies the new name for the workflow. nextStartDate (optional) Date This attribute specifies the next start date. format: date-time protectionGroups (optional) array[String] This attribute specifies the name of a group with which the workflow is associated. restartTimeWindow (optional) String This attribute specifies the maximum grace period from start time to restart of a failed workflow. startInterval (optional) String This attribute specifies the time interval of the workflow operation. startTime (optional) String This attribute specifies the start time of the workflow operation.

PolicyWorkflowList - Up

count (optional) Integer This attribute specifies the number of workflows. format: int32 links (optional) array[Link] workflows (optional) array[PolicyWorkflow] This attribute contains the list of workflows.

PolicyWorkflowOpBackup - Up

actionOverrides (optional) array[PolicyActionSettingOverride]

NetWorker 9.1.x REST API Reference Guide. 346

Dell Customer Communication - Confidential

clients (optional) array[String] This attribute specifies the list of clients to perform all the actions in the workflow. restart (optional) Boolean This attribute specifies whether to restart a failed workflow. vmwareWorkItemSelection (optional) VMwareWorkItemSelection

Pool - Up

autoMediaVerify (optional) Boolean This attribute specifies that automated verification is performed while data is being written to a volume from this pool. barcodePrefix (optional) String This attribute specifies the barcode prefix to select for this pool. comment (optional) String This attribute specifies the user-specified description of this pool or other explanatory remarks. createDltWorm (optional) Boolean This attribute specifies whether DLTWORM tapes can be created. devices (optional) array[String] This attribute specifies the devices on which the volumes can be mounted. enabled (optional) Boolean This attribute specifies whether this pool can be selected. labelTemplate (optional) String This attribute specifies the template to use for labeling the volumes in this pool. links (optional) array[Link] maxParallelism (optional) Integer This attribute specifies the maximum parallel sessions per device allowed for backups to this pool. format: int32 maxVolumesToRecycle (optional) Integer This attribute specifies the maximum number of volumes to be recycled. format: int32 mediaTypeRequired (optional) String 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.

Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost

NetWorker 9.1.x REST API Reference Guide. 347

Dell Customer Communication - Confidential

file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C T10000B T10000 9940B 9940 9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000

NetWorker 9.1.x REST API Reference Guide. 348

Dell Customer Communication - Confidential

dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt

name (optional) String This attribute specifies the name of the pool. poolType (optional) String This attribute determines how volumes that are members of this pool will be used.

NetWorker 9.1.x REST API Reference Guide. 349

Dell Customer Communication - Confidential

Enum: Backup BackupClone Archive ArchiveClone

recycleFromOtherPools (optional) Boolean This attribute determines whether this pool can recycle volumes from other pools. recycleInterval (optional) String This attribute specifies the frequency of recycling runs. The default value is 24:00, which means that recycling runs once a day. recycleStart (optional) String This attribute specifies the time to start recyling (HH:MM). recycleToOtherPools (optional) Boolean This attribute determines whether recyclable volumes can be used by other pools. resourceId (optional) ResourceId storeIndexEntries (optional) Boolean This attribute specifies the file index entries that are generated for this pool. tenant (optional) String This attribute specifies the restricted data zone to which this resource belongs. volumeTypePreference (optional) String This attribute specifies the preferred media type, which is used as a selection factor when a request is made for a writable volume. The preferred type will be considered first within a priority level (jukebox/standalone device). This attribute cannot be set if the media type required attribute is set. This attribute cannot be used to specify the capacity of the media.

Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2

NetWorker 9.1.x REST API Reference Guide. 350

Dell Customer Communication - Confidential

LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C T10000B T10000 9940B 9940 9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85

NetWorker 9.1.x REST API Reference Guide. 351

Dell Customer Communication - Confidential

tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB 4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt

wormPool (optional) Boolean This attribute specifies whether the pool will use WORM tapes (and only WORM tapes). Only tape drives that are WORM capable can be assigned to WORM pools.

PoolList - Up

count (optional) Integer This attribute specifies the number of pools. format: int32 links (optional) array[Link] pools (optional) array[Pool] This attribute contains information about the pools.

Probe - Up

NetWorker 9.1.x REST API Reference Guide. 352

Dell Customer Communication - Confidential

commandOptions (optional) String This attribute specifies probe configuration information. comment (optional) String This attribute specifies any user-defined description for the probe. links (optional) array[Link] name (optional) String This attribute specifies the name of the probe. probeCommand (optional) String This attribute specifies the command to be run as part of the probe. The value must not include a path and must start with the prefix 'save' or 'nsr'. resourceId (optional) ResourceId

ProbeList - Up

count (optional) Integer This attribute specifies the number of probes. format: int32 links (optional) array[Link] probes (optional) array[Probe] This attribute contains information about the probes.

ProtectionGroup - Up

comment (optional) String This attribute specifies any user-specified description or other explanatory remarks. links (optional) array[Link] name (optional) String This attribute specifies the unique name of the protection group. resourceId (optional) ResourceId tenant (optional) String This attribute specifies the associated Restricted Data Zone (RDZ). workItemQueries (optional) array[String] This attribute specifies the query to fetch the resources at runtime. All the resources resulting from this query are protected by this group. The nsrpolicy man page provides details on the options used to create the query type group. workItemSource (optional) String This attribute specifies the work item source type. This value can be either static or dynamic. The static keyword specifies to protect resources specified in the work item. The dynamic keyword specifies to fetch the resources on a run time basis, based on inputs provided in the work item.

Enum: Static

NetWorker 9.1.x REST API Reference Guide. 353

Dell Customer Communication - Confidential

Dynamic workItemSubType (optional) String This attribute specifies the work item subtype, if any. This is applicable for VMware work item type. Valid values are VirtualMachine or VMDK. The protection group can protect data with either VMDK or VirtualMachine but not both.

Enum: VirtualMachine VMDK All None

workItemType (optional) String This attribute specifies the work item type. The type of work item is decided based on the combination of work item source and work item type.

Enum: Client SaveSetId VMware NASDevice

workItems (optional) array[String] This attribute specifies the list of work items. vmwareWorkItemSelection (optional) VMwareWorkItemSelection vmwareWorkItemExclusion (optional) VMwareWorkItemSelection rule (optional) String This attribute specifies the name of the rule. backupOptimization (optional) String This attribute specifies whether backup optimization must be performed based on capacity or performance.

Enum: Capacity Performance

dynamicAssociation (optional) Boolean This attribute enables the dynamic association.

ProtectionGroupList - Up

count (optional) Integer This attribute specifies the number of protection groups. format: int32 links (optional) array[Link] protectionGroups (optional) array[ProtectionGroup] This attribute specifies the information about the protection groups.

Recover - Up

NetWorker 9.1.x REST API Reference Guide. 354

Dell Customer Communication - Confidential

recoveryType (optional) String This attribute specifies the type of recovery.

Enum: Filesystem BBB NDMP VM File Level Recover

recoveryDestination (optional) String This attribute specifies the destination location to which the recovery is performed, as the directory pathname of the file system, NDMP backup, or block based backup. itemsToRecover (optional) array[String] This attribute specifies the list of items to be recovered. For a file system, NDMP backup, or block based backup, specifies the list of full file pathnames. destinationClientResID (optional) String This attribute specifies the destination client ID of the remote machine to direct the recovery. The client ID can be obtained from URI /global/clients. If destination client ID is not provided, the client information from the backup instance is considered for recovery. backupInstance (optional) RecoverBackupInstance timeStampBasedGranularRecover (optional) TimeStampBasedGranularRecover actionForDuplicateItems (optional) String This attribute specifies the action to perform during recovery of the files that are already present at the recovery location.

Enum: Rename Overwrite Skip

targetVolume (optional) String This attribute specifies the target volume to use for the image level recovery of block based backups. poolForStaging (optional) String This attribute specifies the pool for staging that is used for Client Direct disabled devices. Currently used for block based backups. passphrase (optional) array[String] This attribute specifies the additional passphrase to use for recovery of files that were backed up by using the AES directive. recoveryStartTime (optional) String This attribute specifies the time when the recovery started on the NetWorker server. Not supported for an HTTP-POST request. namespace (optional) String This attribute specifies the file index namespace from which to recover the files.

Enum: backup

NetWorker 9.1.x REST API Reference Guide. 355

Dell Customer Communication - Confidential

archive bbb

NDMPOptions (optional) RecoverNDMPOptions links (optional) array[Link] resourceId (optional) ResourceId

RecoverBackupInstance - Up

This attribute specifies the backup instance ID and optional clone ID to identify the backup for recovery. backupID (optional) String This attribute specifies the instance backup ID, as either a long ID or short ID. For the HTTP-POST request, the instance backup ID can be retrieved from URI /global/backups. instanceID (optional) String This attribute specifies the instance ID. For the HTTP-POST request, the instance ID can be retrieved from URI /global/backups.

RecoverList - Up

count (optional) Integer This attribute specifies the number of recover resources. format: int32 recovers (optional) array[Recover] This attribute contains information about the recover resources.

RecoverNDMPOptions - Up

This attribute specifies NDMP recovery options. This attribute is supported for NDMP recovery only. verifyIndexDB (optional) Boolean This attribute specifies whether to verify the existence of files in the index database. By default, the files are verified in the index database prior to recovery. useIPv4 (optional) Boolean This attribute specifies to use the IPv4 addresses for the NDMP data connection during recovery.

ResourceId - Up

The entity represents the unique identifier for a given resource type. It reflects the representation for the resourceidentifier field in nsradmin program, where is is shown as '70.0.77.10.0.0.0.0.208.36.124.87.128.222.109.22(1) id (optional) String This attribute specifies the unique identifier for the associated resource. sequence (optional) Long This attribute specifies the sequencing. format: int64

NetWorker 9.1.x REST API Reference Guide. 356

Dell Customer Communication - Confidential

Rule - Up

dataSourceType (optional) String This attribute specifies the type of data source.

Enum: VMware MSSQL

comment (optional) String This attribute specifies any user-defined description for the rule. definitions (optional) array[RuleItemDefinition] This attribute contains the rule item definitions. links (optional) array[Link] name (optional) String This attribute specifies the name of the rule. matchType (optional) String This attribute specifies the match criteria from the list of rule item definitions as any or all.

Enum: All Any

resourceId (optional) ResourceId

RuleItemDefinition - Up

operator (optional) String This attribute specifies operator for the rule item. There are a number of opreators that can be used in setting up logic conditions. To build a complex logic, regular expression matching operator can be used.

Enum: Equals DoesNotEquals Contains DoesNotContains StartsWith DoesNotStartsWith EndsWith DoesNotEndsWith RegExp

property (optional) String This attribute specifies the rule item property from the predefined list.

Enum: Name Path Tag

type (optional) String This attribute specifies the type of rule item from the predefined list.

NetWorker 9.1.x REST API Reference Guide. 357

Dell Customer Communication - Confidential

Enum: VirtualMachine Cluster vApp VmFolder Datacenter ResourcePool Database

value (optional) String This attribute specifies the value for the rule creation on which the operator is executed.

RuleList - Up

count (optional) Integer This attribute specifies the number of rules. format: int32 links (optional) array[Link] rules (optional) array[Rule] This attribute contains information about the rules.

Schedule - Up

levels (optional) array[String] This attribute specifies the sequence of save levels making up the schedule. One entry isused for each day of the schedule. The valid levels are"full","incr","incr_synth_full","skip","txnlog",andthenumber"1". Enum:

activityType (optional) String

Enum: Backup Execute Server-Backup Vmware

comment (optional) String This attribute is provided for the administrator to keep any explanatory remarks or supplementary information about the schedule. flag (optional) String This read-only attribute specifies whether the schedule is a default or editable schedule. name (optional) String This attribute specifies the schedules name. The schedule is referred to by its name in client resources. overrides (optional) array[ScheduleOverride] This attribute specifies a list of actions and dates overriding the actions specified in the levels attribute. The format of the

NetWorker 9.1.x REST API Reference Guide. 358

Dell Customer Communication - Confidential

override specification is action date. Action must be one of"full","txnlog","incr_synth_full","incr","skip",or the number"1". period (optional) String This attribute specifies the length of the schedules 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". resourceId (optional) ResourceId

ScheduleList - Up

count (optional) Integer Number of schedules. format: int32 links (optional) array[Link] schedules (optional) array[Schedule]

ScheduleOverride - Up

level (optional) String

Enum: 1 full incr incr_synth_full skip txnlog exec

date (optional) String pattern (optional) String level: The attribute specifies the backup level from the predefined list. date: The attribute specifies the particular day for the override. pattern: The attribute specifies the text to select the override days. For Example, full last day every month.

ServerConfiguration - Up

acceptNewRecoverSessions (optional) Boolean This attribute specifies whether the server will accept new recover sessions. acceptNewSessions (optional)

NetWorker 9.1.x REST API Reference Guide. 359

Dell Customer Communication - Confidential

Boolean This attribute specifies whether the server will accept new save sessions. aclPassthrough (optional) Boolean This attribute specifies whether the users are allowed to browse the directories with ACLs regardless of permissions. administrators (optional) array[String] This attribute specifies the list which contains users or groups that are allowed to add, delete, and update all NetWorker resources. authenticationProxyPort (optional) Integer This attribute specifies the TCP port number of the NetWorker authentication service proxy. format: int32 authenticationServiceDatabase (optional) String This attribute specifies the location of the authentication service database. authenticationServicePort (optional) Integer This attribute specifies the TCP port number of the NetWorker authentication service. format: int32 cityOrTown (optional) String This attribute specifies part of the address field to which the enabler code should be mailed. clpLicenseServer (optional) String This attribute specifies the NSR CLP license server hostname, which is the hostname to connect to the CLP/Flexera license server. clpLicenseServerPort (optional) Integer This attribute specifies the NSR CLP license server port, which is the port on which the CLP /Flexera license server is listening. format: int32 clpRefresh (optional) String This attribute specifies that the NSR CLP refresh forces any CLP license to be refreshed. It provides a way to force NetWorker to recognize the existence of FLEXlm servers and the possibility of existing update licenses and capacity licenses. clpSwid (optional) String This attribute specifies a copy of the SWID (Software ID) for use by other Dell EMC tracking entities. clpUom (optional) String This attribute specifies that the NSR CLP UOM, the unit of measure for capacity licenses, is the amount of 'capacity' (in the legacy license sense) requested when a capacity license is checked out from the CLP/ELMS server. comment (optional) String This attribute specifies any user-specified description of this server or other explanatory remarks. company (optional) String This attribute specifies the name of the company for which the license enabler is issued. contactName (optional) String This attribute specifies the name of the individual to contact for license enabler information. country (optional)

NetWorker 9.1.x REST API Reference Guide. 360

Dell Customer Communication - Confidential

String This attribute specifies part of the address field to which the enabler code should be mailed. datazonePassPhrase (optional) String This attribute is used to generate the data zone encryption key for backup and recover operations. If missing, the default passphrase will be used. deviceSharingMode (optional) String This attribute specifies the device sharing mode at the server level; used when device sharing mode is not set at storage node level. Refer to man page nsr_storage_node_resource.

Enum: NoSharing MaximalSharing ServerDefault

disableRpsClone (optional) Boolean This attribute is to enable or disable the RPS (Recover Pipe to Save) implementation for clone operations. emailAddress (optional) String This attribute specifies part of the information required for printing the license enabler. fax (optional) String This attribute specifies part of the information required for printing the license enabler. jobInactivityTimeout (optional) Integer This attribute specifies the global setting for the number of minutes since a job has been heard from, after which it will be declared inactive and will be terminated. This setting is enforced by nsrjobd and replaces environment variable NSR_UNRESPONSIVE_JOB_TIMEOUT. Unlike the group inactivity timeout which applies only to save processes maintaining connection to nsrmmd, this timeout applies to all processes throughout runtime. For example, if a save process were to hang in argument processing, group inactivity setting would never trigger its termination. However, if this attribute is set, it will result in terminating such a suspended process after the number of minutes set in this attribute has passed. An empty string or a value of 0 indicates that no such timeout is in effect. format: int32 jobsdbRetentionInHours (optional) Integer This attribute specifies the minimum time in hours to keep jobs records in the jobs database. format: int32 keepIncompleteBackups (optional) Boolean This attribute specifies whether backup data from an incomplete/aborted CloudBoost backup must be retained for possible recovery. licenseServers (optional) array[String] This attribute specifies list of license servers. manualSaves (optional) Boolean This attribute specifies whether the manual saves are allowed to the server. name (optional) String This attribute specifies that the name of this NetWorker server is the same as the hostname by default.

NetWorker 9.1.x REST API Reference Guide. 361

Dell Customer Communication - Confidential

nasDevicePolicyAllowed (optional) Boolean This attribute enables the restricted data zone users to create and update group resources to select NAS device options. parallelism (optional) Integer This attribute specifies the number of simultaneous save sessions supported by this server. format: int32 phone (optional) String This attribute specifies part of the information required for printing the license enabler. productSerialNumber (optional) String This attribute specifies the product serial number needed for registration. This number is entered from the product registration form. publicArchives (optional) Boolean This attribute specifies whether a user can retrieve archived files that are owned by another user. purchaseDate (optional) String This attribute specifies part of the information required for printing the license enabler. resourceId (optional) ResourceId saveSessionDistribution (optional) String This attribute specifies the threshold for the save session distribution for all clients. The clients will distribute the save sessions to the next storage node in their storage node affinity lists when the overall target sessions or max sessions for all devices on the current storage node is exceeded. Max sessions is the default threshold but the value in the client save session distribution attribute overwrites the max sessions value.

Enum: MaxSessions TargetSessions

serverOSType (optional) String This attribute specifies the server operating system type. serverTimezone (optional) String This attribute specifies the server timezone. siteId (optional) String This attribute specifies the site ID that is needed for enabling mail the home feature. solutionId (optional) String This attribute specifies the solution ID which is a combination of the SWID obtained from the CLP license file and the hostname of the platform on which nsrd is running. stateOrProvince (optional) String This attribute specifies the part of the address field to which the enabler code should be mailed. streetAddress (optional) String This attribute specifies the address to which the enabler code should be mailed. supportEmailAddress (optional)

NetWorker 9.1.x REST API Reference Guide. 362

Dell Customer Communication - Confidential

String This attribute specifies the email address of EMC Customer Support, which is required for the mail home feature. vmwarePolicyAllowed (optional) Boolean This attribute enables the restricted data zone users to create and update group resources to select VMware options. vmwsEnable (optional) Boolean This attribute enables the NetWorker VMware web service daemon, nsrvmwsd, which is a module of VMware integrated data protection. vmwsPort (optional) Integer This attribute specifies the TCP port number of the NetWorker VMware web service daemon, nsrvmwsd. format: int32 vmwsUserName (optional) String This attribute specifies the case-sensitive username of the NetWorker VMware web service. vmwsUserPassword (optional) String This attribute specifies the case-sensitive user password of the NetWorker VMware web service. It is recommended to change the default password for security purposes. volumePriority (optional) String This attribute specifies the priority used for selecting the backup volumes. The value assigned to this attribute determines whether volumes in a jukebox, NearLine Priority, or volumes managed by SmartMedia, SmartMedia Priority are considered first.

Enum: NearLinePriority SmartMediaPriority

wormPoolsOnlyHoldWormTapes (optional) Boolean This attribute specifies whether a WORM pool can hold only WORM tapes (if Yes) or can hold any type of volume (if No). wormTapesOnlyInWormPools (optional) Boolean This attribute specifies whether a WORM tape can only be labelled into a WORM pool (if Yes) or can be labelled into any pool (if No). zipOrPostalCode (optional) String This attribute specifies the part of the address field to which the enabler code should be mailed.

ServerMessage - Up

category (optional) String This attribute specifies the category the server message belongs to. id (optional) String This attribute specifies the server message identifier. message (optional) String This attribute is a list of concise recent general I18N messages about the status of the server. priority (optional) String This attribute specifies the priority of the server message. source (optional)

NetWorker 9.1.x REST API Reference Guide. 363

Dell Customer Communication - Confidential

String This attribute specifies the NetWorker component that generated the message on the server. timestamp (optional) Date This attribute specifies the time when the message was generated. format: date-time

ServerMessageList - Up

count (optional) Integer This attribute specifies the number of server message resources. format: int32 links (optional) array[Link] serverMessages (optional) array[ServerMessage] This attribute contains a list of server message resources.

ServerStatistics - Up

badRecovers (optional) Long This attribute specifies the number of bad recovery operations. format: int64 badSaves (optional) Long This attribute specifies the number of bad save operations. format: int64 currentRecovers (optional) Long This attribute specifies the number of current recovery operations. format: int64 currentSaves (optional) Long This attribute specifies the number of current saving operations. format: int64 links (optional) array[Link] maxRecovers (optional) Long This attribute specifies the number of maximum recovery operations. format: int64 maxSaves (optional) Long This attribute specifies the number of maximum saving operations. format: int64 recoverSize (optional) Size This attribute specifies the size (in KB) of recovery operations. recovers (optional) Long This attribute specifies the total number of recovery operations. format: int64 saveSize (optional) Size This attribute specifies the size (in KB) of saving operations. saves (optional) Long This attribute specifies the total number of saving operations. format: int64 upSince (optional)

NetWorker 9.1.x REST API Reference Guide. 364

Dell Customer Communication - Confidential

Date This attribute specifies the server up time. format: date-time version (optional) String This attribute specifies the NetWorker server version.

Session - Up

clientHostname (optional) String This attribute specifies the client hostname. completed (optional) Boolean This attribute indicates whether the session is completed. compressionRatio (optional) BigDecimal This attribute specifies the compression ratio. format: int64 device (optional) String This attribute specifies the compression ratio. deviceFamily (optional) String This attribute specifies the device family.

Enum: Tape Disk Cloud Logical

deviceType (optional) String This attribute specifies the device type.

Enum: Data Domain DD Cloud Tier protectpoint objstr Atmos COS adv_file Cloud Boost file logical Auto Detected LTO Ultrium-8 LTO Ultrium-7 LTO Ultrium-6 LTO Ultrium-5 LTO Ultrium-4 LTO Ultrium-3 LTO Ultrium-2 LTO Ultrium LTO Accelis TS1140 TS1130 TS1120 T10000D T10000C

NetWorker 9.1.x REST API Reference Guide. 365

Dell Customer Communication - Confidential

T10000B T10000 9940B 9940 9840D 9840C 9840b 9840 9490 4890 3592 3590 3570 3480 optical dtf2 dtf dst dst (NT) VXA-320 VXA-172 VXA-2 VXA sdlt600 sdlt320 sdlt dlt-v4 dlt-s4 dlt 20GB dlt vs160 dlt8000 dlt7000 dlt1 dlt tzs20 tz90 tz89 tz88 tz87 tz86 tz85 tkz90 tk70 tk50 4mm DAT160 4mm DAT72 4mm 20GB 4mm 12GB

NetWorker 9.1.x REST API Reference Guide. 366

Dell Customer Communication - Confidential

4mm 8GB 4mm 4GB 4mm 8mm Mammoth-3 8mm Mammoth-2 SAIT-2 SAIT-1 8mm AIT-5 8mm AIT-4 8mm AIT-3 8mm AIT-2 8mm AIT 8mm 20GB 8mm 7GB 8mm 5GB 8mm SD3 SLR qic travan10 generic256 generic128 generic CentricStor vhs himt

endTime (optional) Date This attribute specifies the session end time. format: date-time extendedInformation (optional) String This attribute specifies the extended information about the session. id (optional) Integer This attribute specifies the session ID. itemIdLong (optional) Long This attribute specifies the long ID for the session. format: int64 jobId (optional) Long This attribute specifies the associated job ID. format: int64 links (optional) array[Link] mode (optional) String This attribute specifies the session mode.

Enum: Unknown Saving Recovering Browsing

pool (optional) String This attribute specifies the associated pool. protectionGroup (optional)

NetWorker 9.1.x REST API Reference Guide. 367

Dell Customer Communication - Confidential

String This attribute specifies the associated protection group. rootJobId (optional) Long This attribute specifies the associated root job ID. format: int64 saveSet (optional) String This attribute specifies the associated save set. saveSetId (optional) String This attribute specifies ID of the associated save set. size (optional) Size startTime (optional) Date This attribute specifies the session start time. format: date-time stopped (optional) Boolean This attribute specifies if the session is stopped. tenant (optional) String This attribute specifies the associated Restricted Data Zone (RDZ). totalRecoverSize (optional) Size This attribute specifies the total recover size. totalRecoverVolumesNeeded (optional) Long This attribute specifies the number of recovery volumes needed. format: int64 transferRate (optional) BitRate This attribute specifies the transfer rate. volume (optional) String This attribute specifies the associated volume.

SessionList - Up

count (optional) Integer This attribute specifies the number of sessions. format: int32 links (optional) array[Link] sessions (optional) array[Session] This attribute contains the information about the sessions.

Size - Up

unit (optional) String Unit of measurement in bytes or kilobytes.

Enum: Byte KB

value (optional) Long format: int64

StorageNode - Up

aftdAllowedDirectories (optional)

NetWorker 9.1.x REST API Reference Guide. 368

Dell Customer Communication - Confidential

array[String] This attribute indicates which base directories are allowed to create an AFTD for a given storage node. It is strongly encouraged to specify the list of an AFTD allowed directories for each storage node to safeguard underlying file system integrity, and control an AFTD backup directories. cloneStorageNodes (optional) array[String] 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. comment (optional) String This attribute specifies any user-defined description of this client or other explanatory remarks. configuredDevices (optional) array[String] This attribute specifies the devices currently defined for this storage node. configuredLibraries (optional) array[String] This attribute specifies the libraries currently defined for this storage node. configuredLibraryTypes (optional) array[String] This attribute specifies the type of libraries defined on this storage node. configuredSilos (optional) array[String] This attribute specifies the silos currently defined for this storage node. configuredSiloTypes (optional) array[String] This attribute specifies the type of silos currently defined for this storage node. daemonVersions (optional) array[String] This attribute specifies the storage node daemon versions. Storage node daemons are responsible for NetWorker save and recover media multiplexing operations. dateOfLastScan (optional) Date This attribute specifies the date that the auto-detect process was last run. format: date-time dateOfRegistration (optional) 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. format: date-time dedicatedStorageNode (optional) Boolean This attribute indicates whether this is a dedicated storage node. deviceSharingMode (optional) String This attribute specifies the device sharing setting at the storage node level.

Enum: NoSharing MaximalSharing ServerDefault

dynamicNsrmmds (optional)

NetWorker 9.1.x REST API Reference Guide. 369

Dell Customer Communication - Confidential

Boolean This attribute specifies whether nsrmmd processes on this storage node device are started dynamically. enabled (optional) Boolean This attribute specifies whether the storage node is available for use. lastErrorMessages (optional) array[String] This attribute specifies the error messages logged by the detection (dvdetect) process during the last time that device auto-detection was run on this storage node. lastErrorNumber (optional) Integer This attribute specifies the error number logged by the detection (dvdetect) process during the last time that device auto-detection was run on this storage node. format: int32 links (optional) array[Link] maxActiveDevices (optional) Integer This attribute specifies the maximum number of devices that NetWorker may use from this storage node. format: int32 name (optional) String This attribute specifies the name of the storage node. numberOfDevices (optional) Integer This attribute specifies the count of the devices defined on this storage node. format: int32 numberOfLibraries (optional) Integer This attribute specifies the count of the libraries defined on this storage node. format: int32 password (optional) String This attribute specifies the password used to connect to the Network Data Management Protocol (NDMP) server. ready (optional) Boolean This attribute specifies whether the storage node is ready to accept device operations. remoteUser (optional) String This attribute specifies the username used to connect to the Network Data Management Protocol (NDMP) server. resourceId (optional) ResourceId searchAllLuns (optional) Boolean This attribute specifies whether to search all the LUNs for every SCSI target. sharedDeviceCreation (optional) Boolean This attribute specifies whether to allow the restricted data zone (RDZ) users to create new devices or jukeboxes on the storage node if the storage node is shared. A storage node is shared if it has no RDZ associations. skipScsiTargets (optional) Boolean This attribute specifies whether the auto-detect process skips the SCSI targets. storageNodeIsConfigured (optional)

NetWorker 9.1.x REST API Reference Guide. 370

Dell Customer Communication - Confidential

Boolean This attribute specifies whether a device has already been configured on this storage node. tenant (optional) String This attribute specifies the name of the restricted data zone (RDZ) to which the storage node belongs. typeOfStorageNode (optional) String This attribute specifies the storage node type from the predefined list.

Enum: SCSI NDMP SILO

usePersistentNames (optional) Boolean This attribute indicates whether NetWorker should use any available persistent device names when it searches for tape drives and medium changers. version (optional) String This attribute specifies the storage node version.

StorageNodeList - Up

count (optional) Integer This attribute specifies the number of storage nodes. format: int32 links (optional) array[Link] storageNodes (optional) array[StorageNode] This attribute contains information about the storage nodes.

Tenant - Up

A tenant represents information about a NetWorker restricted data zone (RDZ). clientHostnames (optional) array[String] This attribute specifies the list of associated clients for this restricted data zone. comment (optional) String This attribute specifies the user-defined description of this restricted data zone. devices (optional) array[String] This attribute specifies the list of associated directives for this restricted data zone. directives (optional) array[String] This attribute specifies the list of directives of this restricted data zone. externalRoles (optional) array[String] This attribute specifies the list that contains LDAP users or groups that are in this restricted data zone. jukeboxes (optional) array[String] This attribute specifies the list of associated jukeboxes for this restricted data zone. labels (optional)

NetWorker 9.1.x REST API Reference Guide. 371

Dell Customer Communication - Confidential

array[String] This attribute specifies the list of associated labels for this restricted data zone. links (optional) array[Link] name (optional) String This attribute specifies the name of the restricted data zone. numberOfClients (optional) Integer This attribute specifies the number of clients that can be configured for this restricted data zone. format: int32 numberOfDevices (optional) Integer This attribute specifies the number of devices that can be configured for this restricted data zone. format: int32 numberOfJukeboxes (optional) Integer This attribute specifies the number of jukeboxes that can be configured for this restricted data zone. format: int32 numberOfStorageNodes (optional) Integer This attribute specifies the number of storage nodes that can be configured for this restricted data zone. format: int32 pools (optional) array[String] This attribute specifies the list of associated media pools for this restricted data zone. privileges (optional) array[String] This attribute specifies the privileges of the members of this restricted data zone.

Enum: protectionGroups (optional) array[String] This attribute specifies the list of associated protection groups for this restricted data zone. protectionPolicies (optional) array[String] This attribute specifies the list of associated data protection policies for this restricted data zone. recovers (optional) array[String] This attribute specifies the list of associated scheduled recoveries for this restricted data zone. resourceId (optional) ResourceId storageNodes (optional) array[String] This attribute specifies the list of associated storage nodes for this restricted data zone. users (optional) array[String] This attribute specifies the list of users or groups that are in this restricted data zone.

TenantList - Up

count (optional) Integer This attribute specifies the number of tenants. format: int32 links (optional)

NetWorker 9.1.x REST API Reference Guide. 372

Dell Customer Communication - Confidential

array[Link] tenants (optional) array[Tenant] This attribute contains the information about the tenants.

TimeStampBasedGranularRecover - Up

This attribute specifies the source client resource ID and timestamp to identify the backup for recovery. sourceClientResID (optional) String This attribute specifies the resource ID to uniquely identify the source client. timeStamp (optional) String This attribute specifies the backup savetime in the format yyyy-mm- ddThh:mm:ssXXX (2017-10-07T21:00:13+05:30) or in epoch time format (1507237222).

UserGroup - Up

comment (optional) String This attribute specifies the user-defined description of this user group or explanatory remarks. externalRoles (optional) array[String] This attribute specifies the roles from the directory service. links (optional) array[Link] name (optional) String This attribute specifies the name of the user group. privileges (optional) array[String] This attribute specifies the privileges of members of this user group.

Enum: resourceId (optional) ResourceId users (optional) array[String] This attribute contains users or groups that are in this user group, as in user=sam,host=jupiter (user sam on machine jupiter), host=jupiter (any user on machine jupiter).

UserGroupList - Up

count (optional) Integer This attribute specifies the number of user groups. format: int32 links (optional) array[Link] userGroups (optional) array[UserGroup] This attribute contains information about the user groups.

VCenter - Up

NetWorker 9.1.x REST API Reference Guide. 373

Dell Customer Communication - Confidential

cloudDeployment (optional) Boolean This attribute indicates whether the hypervisor is running on the cloud. comment (optional) String This attribute specifies the user-defined description of this resource or any explanatory remarks. hostname (optional) String This attribute specifies the hostname of the server hosting the virtual machine monitor. links (optional) array[Link] resourceId (optional) ResourceId userName (optional) String This attribute specifies the username of the virtual machine monitor. userPassword (optional) String This attribute specifies the password of the virtual machine monitor.

VCenterList - Up

count (optional) Integer This attribute specifies the number of vCenters. links (optional) array[Link] vCenters (optional) array[VCenter] This attribute contains the list of vCenters.

VCenterPlugin - Up

pluginType (optional) String This attribute specifies the type of plug-in to install from the predefined list.

Enum: VC EBR

nwUserId (optional) String This attribute specifies the NetWorker administrator username used to connect to VC or EBR REST APIs. nwPassword (optional) String This attribute specifies the NetWorker administrator password used to connect to VC or EBR REST APIs. httpsPort (optional) Integer This attribute specifies the vCenter https port number, the default value is 443. httpPort (optional) Integer This attribute specifies the vCenter http port number, the default value is 80. authcIp (optional) String This attribute specifies the IP address or hostname of the AuthC service.

NetWorker 9.1.x REST API Reference Guide. 374

Dell Customer Communication - Confidential

authcPort (optional) Integer This attribute specifies the port of the AuthC service.

VCenterPluginResponse - Up

status (optional) String This attribute specifies the status of plug-in installation. output (optional) EBRSession . resultCode (optional) String

VMwareApplicationRecoverSavesetInfo - Up

applicationData (optional) String backupId (optional) String This attribute specifies the backup identifier. instanceId (optional) String This attribute specifies the backup instance identifier.

VMwareProtectedVm - Up

hasAppConsistencyBackup (optional) Boolean This attribute indicates whether the backup has an app consistent backup. hostname (optional) String This attribute specifies the guest OS hostname. ipAddress (optional) String This attribute specifies the guest OS IP address. links (optional) array[Link] morefId (optional) String This attribute specifies the Managed Object Reference ID of the VM. name (optional) String This attribute specifies the name of the VM. osId (optional) String This attribute specifies the operating system identifier. osName (optional) String This attribute specifies the operating system name. uuid (optional) String This attribute specifies the Universal Unique Identifier of the VM. vCenterHostname (optional) String This attribute specifies the VCenter hostname. version (optional) String This attribute specifies the VMX version. VMware VMX files are the configuration files for VMware guest operating systems.

NetWorker 9.1.x REST API Reference Guide. 375

Dell Customer Communication - Confidential

VMwareProtectedVmList - Up

count (optional) Integer This attribute specifies the number of protected virtual machines. links (optional) array[Link] vms (optional) array[VMwareProtectedVm]

VMwareVm - Up

annotation (optional) String This attribute specifies the annotation of the VM. connectionState (optional) String This attribute specifies the connection state of the VM. The value of this attribute can be connected, notResponding, or disconnected. hostname (optional) String This attribute specifies the hostname of the VM. ipAddress (optional) String This attribute specifies the IP address of the VM. ipAddresses (optional) array[String] This attribute specifies the IP addresses of the VM. links (optional) array[Link] morefId (optional) String This attribute specifies the Managed Object Reference ID of the VM. name (optional) String This attribute specifies the name of the VMware virtual machine. osId (optional) String This attribute specifies the OS identifier. osName (optional) String This attribute specifies the OS name. powerState (optional) String This attribute specifies the power state of the VM. The value of this attribute can be poweredOn, poweredOff, standby, or unknown. state (optional) String This attribute specifies the state of the machine as running or not running. status (optional) String This attribute describes the virtual machine status in color-coded format. type (optional) String This attribute specifies the type of virtual machine. uuid (optional) String This attribute specifies the Universal Unique Identifier of the VM. vCenterHostname (optional) String This attribute specifies the VCenter hostname. version (optional)

NetWorker 9.1.x REST API Reference Guide. 376

Dell Customer Communication - Confidential

String This attribute specifies the VMX version. VMware VMX files are the configuration files for VMware guest operating systems.

VMwareVmBackupInfo - Up

datastoreMoref (optional) String This attribute specifies the data store Managed Object Reference ID. disks (optional) array[VMwareVmdkBackupInfo] hostMoref (optional) String This attribute specifies the host Managed Object Reference ID. morefPath (optional) String This attribute specifies the Managed Object Reference path. vCenterHostname (optional) String This attribute specifies the vCenter host name. vmMoref (optional) String This attribute specifies the virtual machine Managed Object Reference ID. vmName (optional) String This attribute specifies the virtual machine name.

VMwareVmEmergencyRecoverCleanupOptions - Up

This is a mandatory attribute when recoverMode is set to "Emergency"; otherwise, it is not supported. This attribute specifies the options for cleaning up ESX, proxy, and client resources at the end of the emergency recovery. deleteEsxClient (optional) Boolean This attribute specifies whether the ESX client must be deleted at the end of emergency recovery. deleteEsxHypervisor (optional) Boolean This attribute specifies whether the ESX hypervisor resource must be deleted at the end of emergency recovery. deleteVproxy (optional) Boolean This attribute specifies whether the vProxy resource must be deleted at the end of emergency recovery. vCenterHostnameForVproxy (optional) String This attribute specifies to which vCenter the vProxy must be associated at the end of emergency recovery. Used only if the deleteVproxy option is unset or set to "false".

VMwareVmFlrOptions - Up

This is a mandatory attribute when recoverMode is set to "FLR"; otherwise, it is not supported. This atribute specifies the target guest VM where the application recovery will be performed. recoveryDestination (optional) String This attribute specifies the destination on the target VM to which the recovered files will be copied.

NetWorker 9.1.x REST API Reference Guide. 377

Dell Customer Communication - Confidential

elevateUser (optional) String This attribute specifies whether the recover has to be performed with elevated (administrator) authority. itemsToRecover (optional) array[String] This attribute specifies the list of items to be recovered. terminateMountSession (optional) Boolean This attribute specifies whether the mount session should be terminated at the end of recovery. overwrite (optional) Boolean This attribute specifies whether the files should be forcefully overwritten if they are present in the destination directory.

VMwareVmGuestInfo - Up

This is a mandatory attribute when recoverMode is set to "Application"; otherwise, it is not supported. This attribute specifies the target guest VM where the application recovery will be performed. installAppAgent (optional) Boolean This attribute specifies whether to install the Microsoft Virtual Machine Application Agent (MSVMAPPAGENT) which is required for application-consistent VMware recover. targetVmAdminUserId (optional) String This attribute specifies the target VM administrator user ID. targetVmAdminUserPassword (optional) String This attribute specifies the target VM administrator user password. targetVmUserId (optional) String This attribute specifies the target VM user ID. targetVmUserPassword (optional) String This attribute specifies the target VM user password. uninstallAppAgent (optional) Boolean This attribute specifies whether to uninstall the Microsoft Virtual Machine Application Agent (MSVMAPPAGENT) which is required for application- consistent VMware recover.

VMwareVmList - Up

count (optional) Integer This attribute specifies the number of virtual machines. links (optional) array[Link] vms (optional) array[VMwareVm]

VMwareVmOpBackup - Up

policy (optional) String This attribute specifies the policy name of the backup. workflow (optional)

NetWorker 9.1.x REST API Reference Guide. 378

Dell Customer Communication - Confidential

String This attribute specifies the workflow name of the backup.

VMwareVmOpRecover - Up

applicationData (optional) String This attribute is optional when recoverMode is set to "Application"; otherwise, it is not supported. This attribute specifies the JSON data to be passed to application agent for restore. applicationName (optional) String This attribute is mandatory when recoverMode is set to "Application"; otherwise, it is not supported. This attribute specifies the application name to be restored. applicationRestoreSavesets (optional) array[VMwareApplicationRecoverSavesetInfo] This attribute is optional when recoverMode is set to "Application"; otherwise, it is not supported. This attribute specifies the list of save sets to be restored in sequence. clusterComputeResourceMoref (optional) String This is an optional attribute when recoverMode is set to "New" or "Instant"; otherwise, it is not supported. Either clusterComputeResourceMoref or computeResourceMoref needs to be set to specify under which host or cluster the VM will be restored. computeResourceMoref (optional) String This is an optional attribute when recoverMode is set to "New" or "Instant"; otherwise, it is not supported. Either clusterComputeResourceMoref or computeResourceMoref needs to be set to specify under which host or cluster the VM will be restored. datacenterMoref (optional) String This is a mandatory attribute when recoverMode is set to "New" or "Instant"; otherwise, it is not supported. This attribute specifies to which data center the VM is restored. datastoreMoref (optional) String This is a mandatory attribute when recoverMode is set to "New" or "Emergency"; otherwise, it is not supported. This attribute specifies to which datastore VM files are restored. debugLevel (optional) Integer This attribute specifies the debug level to be used during restore. deleteExistingBackingFile (optional) Boolean This is a mandatory attribute when recoverMode is set to "Revert" and when the configuration recovery is also set; otherwise, it is not supported. This attribute specifies whether the existing disk will be deleted in case of disk configuration mismatch. disks (optional) array[VMwareVmdkRecoverInfo] This is a mandatory attribute when recoverMode is set to "New", "Disk", or "Emergency", and optional when recoverMode is set to "Revert". Otherwise, it is not supported. This attribute specifies which disks will be restored and to which datastore. If not set and recoverMode is set to "Revert", then all disks will be reverted. hostMoref (optional)

NetWorker 9.1.x REST API Reference Guide. 379

Dell Customer Communication - Confidential

String This is an optional attribute when recoverMode is set to "New" or "Instant"; otherwise, it is not supported. This attribute specifies to which host the VM is restored. This is not required when restoring to a DRS-enabled cluster. jobName (optional) String This is an optional attribute for all recoverMode values. This attribute specifies the name of the job that will be created. mountJobId (optional) String This is a mandatory attribute when recoverMode is set to "Application"; otherwise, it is not supported. This attribute specifies the mount job ID to be used by the restore session. powerOn (optional) Boolean This is a mandatory attribute when recoverMode is set to "Revert", "Instant", "New", "Disk", or "Emergency"; otherwise, it is not supported. This attribute specifies whether to power on the VM at the end of the restore. reconnectNic (optional) Boolean This is a mandatory attribute when recoverMode is set to "Revert", "Instant", "New", "Disk", or "Emergency"; otherwise, it is not supported. This attribute specifies whether to reconnect the NIC of the VM at the end of the restore. recoverMode (optional) String This is a mandatory attribute. This attribute specifies the type of the restore.

Enum: Revert Instant New Disk Application FLR Emergency

resourcePoolMoref (optional) String This is an optional attribute when recoverMode is set to "New" or "Instant"; otherwise, it is not supported. This attribute specifies the resource pool to which the VM will be restored. revertConfiguration (optional) Boolean This is a mandatory attribute when recoverMode is set to "Revert"; otherwise, it is not supported. This attribute specifies whether to revert the VM configuration. stagingPool (optional) String This is an optional attribute for all recoverMode values. This attribute specifies which staging pool to use on the DD device when restoring from a clone. vCenterHostname (optional) String This is a mandatory attribute when recoverMode is set to "New", "Instant", "Disk", or "Emergency"; otherwise, it is not supported. This attribute specifies to which vCenter or ESX the VM or disk is restored. vmEmergencyRecoverCleanupOptions (optional) VMwareVmEmergencyRecoverCleanupOptions

NetWorker 9.1.x REST API Reference Guide. 380

Dell Customer Communication - Confidential

vmFolderMoref (optional) String This is a mandatory attribute when recoverMode is set to "New"; otherwise, it is not supported. This attribute specifies the VM folder under which the VM will be recovered. vmGuestLogin (optional) VMwareVmGuestInfo vmMoref (optional) String This is a mandatory attribute when recoverMode is set to "Disk" or "Application"; otherwise, it is not supported. This attribute specifies to which VM the restored disk will be attached. vmName (optional) String This is a mandatory attribute when recoverMode is set to "New", "Instant", "Disk", "Application", or "Emergency"; otherwise, it is not supported. This attribute specifies either the restored VM name or, when recoverMode is "Disk" or "Application", the existing VM name to which the restored disk will be attached. vmwareVmFlrOptions (optional) VMwareVmFlrOptions vProxyHostname (optional) String This is a mandatory attribute when recoverMode is set to "Emergency". It is optional when recoverMode is set to "Revert", "New", "Instant", "Disk", or "Application"; otherwise, it is not supported. This attribute specifies the vProxy to be used for recovery.

VMwareVmProtectionDetail - Up

protectionGroup (optional) ProtectionGroup This attribute specifies the protection group details. protectionPolicy (optional) Policy This attribute specifies the protection policy details. workflow (optional) PolicyWorkflow This attribute specifies the workflow details.

VMwareVmProtectionDetailList - Up

count (optional) Integer This attribute specifies the number of protection details. links (optional) array[Link] protectionDetails (optional) array[VMwareVmProtectionDetail] This attribute contains the information about the protection details.

VMwareVmdkBackupInfo - Up

datastoreMoref (optional) String This attribute specifies the data store Managed Object Reference ID. datastoreName (optional)

NetWorker 9.1.x REST API Reference Guide. 381

Dell Customer Communication - Confidential

String This attribute specifies the data store name. key (optional) String This attribute specifies the key. name (optional) String This attribute specifies the name. sizeInKb (optional) Integer This attribute specifies the size in kilo bytes. thinProvisioned (optional) Boolean This attribute indicates whether it is thin provisioned.

VMwareVmdkRecoverInfo - Up

datastoreMoref (optional) String This attribute specifies the Managed Object Reference ID associated with the destination datastore for this disk. This is a mandatory attribute. key (optional) String This attribute specifies the key of the disk, which can be retrieved from the vmInformation property of a backup. This is a mandatory attribute. name (optional) String This attribute specifies the name of the disk, which can be retrieved from the vmInformation property of a backup. This is a mandatory attribute.

VMwareVmdkWorkItem - Up

vmUuid (optional) String This attribute specifies the Universal Unique Identifier (UUID) of the virtual machine. vmdkUuid (optional) String This attribute specifies the Universal Unique Identifier (UUID) of the virtual machine disk (VMDK).

VMwareWorkItemOpUpdate - Up

addWorkItems (optional) VMwareWorkItemSelection deleteWorkItems (optional) VMwareWorkItemSelection

VMwareWorkItemSelection - Up

vCenterHostname (optional) String This attribute specifies the vCenter hostname. containerMorefs (optional) array[String] This attribute specifies the list of container Managed Object Reference IDs. vmUuids (optional) array[String] This attribute specifies the Universal Unique Identifier (UUID) of VMs. vmdks (optional)

NetWorker 9.1.x REST API Reference Guide. 382

Dell Customer Communication - Confidential

array[VMwareVmdkWorkItem] This attribute specifies the list of Virtual Machine Disks.

VProxy - Up

comment (optional) String This attribute specifies any user-defined description of this resource or other explanatory remarks. datastores (optional) array[String] This attribute specifies the datastores which this proxy can access. enabled (optional) Boolean This attribute indicates whether the VM proxy is available for use. encryptNbdSessions (optional) Boolean This attribute indicates whether to enable NBDSSL, which encrypts NBD sessions with SSL. This option takes effect only if the maximum NBD sessions attribute is set to a positive value. forceRegister (optional) Boolean This attribute specifies whether or not to force register. hostname (optional) String This attribute specifies the hostname of the vProxy. links (optional) array[Link] maxHotaddDisks (optional) Integer This attribute specifies the maximum number of virtual disks that NetWorker can concurrently hotadd to the vProxy appliance. maxHotaddSessions (optional) Integer This attribute specifies the maximum VM clients this vProxy appliance will concurrently support through HotAdd. maxNbdSessions (optional) Integer This attribute specifies the maximum VM sessions this vProxy appliance will concurrently support through NBD. password (optional) String This attribute specifies the user password to connect to the proxy host. resourceId (optional) ResourceId userName (optional) String This attribute specifies the username to connect to the vProxy appliance. version (optional) String This attribute specifies the vProxy appliance version. vCenterHostname (optional) String This attribute specifies the vCenter which this proxy services. vProxyPort (optional) Integer This attribute specifies the TCP port number of the proxy service.

VProxyList - Up

count (optional) Integer This attribute specifies the number of vProxy appliances.

NetWorker 9.1.x REST API Reference Guide. 383

Dell Customer Communication - Confidential

links (optional) array[Link] vProxies (optional) array[VProxy]

VProxyVmBrowseSessionPutOrPostResponse - Up

config (optional) VProxyVmBrowseSessionResponseConfig This attribute specifies the configuration information of the browse session. status (optional) VProxyVmBrowseSessionResponseStatus This attribute specifies the status information of the browse session.

VProxyVmBrowseSessionRequest - Up

currentWorkingDirectory (optional) String This attribute specifies the path relative to the mount point or absolute path within the mounted backup location. idleTimeout (optional) Integer This attribute specifies the idle timeout in seconds for the browse session. cacheRetentionSeconds (optional) Integer This attribute specifies the time in seconds after which cached contents of the current working directory will be considered stale. browseDestination (optional) Boolean This attribute specifies whether the destination VM should be browsed. The default value is false. osType (optional) String This attribute specifies the destination VM operating system type.

Enum: Windows Linux

elevateUser (optional) Boolean This attribute specifies whether the browse has to be performed with elevated (administrator) authority.

VProxyVmBrowseSessionResponse - Up

config (optional) VProxyVmBrowseSessionResponseConfig This attribute specifies the configuration information of the browse session. status (optional) VProxyVmBrowseSessionResponseStatus This attribute specifies the status information of the browse session. links (optional) array[Link]

NetWorker 9.1.x REST API Reference Guide. 384

Dell Customer Communication - Confidential

VProxyVmBrowseSessionResponseConfig - Up

sessionId (optional) String This attribute specifies the browse session identifier. currentWorkingDirectory (optional) String This attribute specifies the path relative to the mount point or absolute path within the mounted backup location. idleTimeout (optional) Integer This attribute specifies the idle timeout in seconds for the browse session. cacheRetentionSeconds (optional) Integer This attribute specifies the time in seconds after which cached contents of the current working directory will be considered stale. browseDestination (optional) Boolean This attribute indicates whether the destination VM should be browsed.

VProxyVmBrowseSessionResponseList - Up

count (optional) Integer This attribute specifies the number of browse session responses. links (optional) array[Link] sessions (optional) array[VProxyVmBrowseSessionResponse]

VProxyVmBrowseSessionResponseStatus - Up

state (optional) String This attribute specifies the status of the browse session, as Queued, Running, Success, Failure, or Cancelled. description (optional) String This attribute specifies the status description of the browse session.

VProxyVmMountSessionResponse - Up

config (optional) VProxyVmMountSessionResponseConfig This attribute specifies the configuration information on this current mount session. status (optional) VProxyVmMountSessionResponseStatus This attribute specifies the status information on this current mount session. links (optional) array[Link]

VProxyVmMountSessionResponseConfig - Up

mountPointPath (optional) String This attribute specifies the mount point path of the mounted session. idleTimeout (optional)

NetWorker 9.1.x REST API Reference Guide. 385

Dell Customer Communication - Confidential

Integer This attribute specifies the idle timeout of the mounted session.

VProxyVmMountSessionResponseStatus - Up

state (optional) String This attribute specifies the status of mounted session. description (optional) String This attribute specifies the status description of mounted session.

Volume - Up

accessTime (optional) Date This attribute specifies the access time. format: date-time availabilityFlags (optional) array[String] This attribute specifies the availability flag. More than one availability flag can be specified.

Enum: barcode (optional) String This attribute specifies the barcode label for the volume. capacity (optional) Size This attribute specifies the capacity of the volume. expirationTime (optional) Date This attribute specifies the expiration time for the volume. format: date- time family (optional) String This attribute specifies the family of the device currently associated with the volume. flags (optional) array[String] This attribute specifies the flags to provide additional details.

Enum: id (optional) String This attribute specifies host identifier of the volume. latestLabelTime (optional) Date This attribute specifies latest label time. format: date-time links (optional) array[Link] location (optional) String This attribute specifies the administrator-defined description of a physical location of the volume. mounts (optional) Long This attribute specifies the number of mount operations. format: int64 name (optional) String This attribute specifies the name of the volume. originalLabelTime (optional) Date This attribute specifies the original label time. format: date-time pool (optional) String This attribute specifies the pool to which the volume belongs. recover (optional)

NetWorker 9.1.x REST API Reference Guide. 386

Dell Customer Communication - Confidential

Size This attribute specifies the amount of data recovered from the volume. recycled (optional) Long This attribute specifies the number of times the volume has been recycled. format: int64 saveSetExpirationTime (optional) Date This attribute specifies the save set expiration time. format: date-time saveSetIds (optional) array[String] This attribute specifies the IDs of all the save sets on the volume. states (optional) array[String] This attribute specifies whether the volume is WORM (write once, read many) capable, recyclable, manual recyclable, and archive.

Enum: tenant (optional) String This attribute specifies the name of the restricted data zone (RDZ) to which the associated device belongs. type (optional) String This attribute specifies the media type of the device currently associated with the volume. written (optional) Size This attribute specifies the amount of data written on the volume.

VolumeList - Up

count (optional) Integer This attribute specifies the number of volumes. format: int32 links (optional) array[Link] volumes (optional) array[Volume] This attribute contains information about the volumes.

XmlError - Up

This attribute specifies the information about the error. text (optional) String This attribute specifies the error message that appeared while retrieving the content of the session. code (optional) Integer This attribute specifies the error code that appeared while retrieving the content of the session.

XmlFile - Up

fileName (optional) String This attribute specifies the name of the file. fileType (optional) String This attribute specifies the file type value that can be file, directory, or symlink. fileSize (optional)

NetWorker 9.1.x REST API Reference Guide. 387

Dell Customer Communication - Confidential

Integer This attribute specifies the size of the file in bytes. fileModificationTime (optional) String This attribute specifies the time when the file was last modified.

XmlVmBrowseDirectoryContents - Up

error (optional) XmlError noMoreData (optional) Boolean This attribute indicates whether additional data exists. The value true indicates that no additional data is available. totalObjects (optional)

Manualsnet FAQs

If you want to find out how the 19.1 Dell works, you can view and download the Dell NetWorker 19.1 Software REST API Reference Guide on the Manualsnet website.

Yes, we have the REST API Reference Guide for Dell 19.1 as well as other Dell manuals. All you need to do is to use our search bar and find the user manual that you are looking for.

The REST API Reference Guide should include all the details that are needed to use a Dell 19.1. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell NetWorker 19.1 Software REST API Reference Guide is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.

This Dell NetWorker 19.1 Software REST API Reference Guide consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.

You can download Dell NetWorker 19.1 Software REST API Reference Guide free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.

To be able to print Dell NetWorker 19.1 Software REST API Reference Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell NetWorker 19.1 Software REST API Reference Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.