BMC Atrium Orchestrator Application Adapter for Symantec ...€¦ · Table of Contents 2 Version...

User Documentation January 2014

BMC Atrium OrchestratorApplication Adapter forSymantec NetBackup

Version 1.0.00

Table of Contents 2

Version 1.0.00

BMC Atrium Orchestrator Application Adapter for Symantec NetBackup

Table of Contents...........................................................................................................................7Actor Adapter

...........................................................................................................................9Adapter Module Life Cycle

...........................................................................................................................10Requirements

...........................................................................................................................11Installing the Adapter

...........................................................................................................................14Configuring the Symantec NetBackup Adapter

...........................................................................................................................17Support for Multiple Configuration

...........................................................................................................................17Enabling the Debug Mode

...........................................................................................................................20SetupValidation

...........................................................................................................................20Utilities

...........................................................................................................................20Version Directory

...........................................................................................................................22Symantec NetBackup Actor Adapter

...........................................................................................................................24Additional Information for Writing an Adapter request

...........................................................................................................................24Environment Operation

...........................................................................................................................24Operation: get-environment

...........................................................................................................................28Command Operation

...........................................................................................................................28Operation: nbu-execute

...........................................................................................................................30Policy Operations

...........................................................................................................................31Operation: get-policy

...........................................................................................................................33Operation: activate-policy

...........................................................................................................................35Operation: deactivate-policy

...........................................................................................................................37Client Operations

...........................................................................................................................37Operation: get-client

...........................................................................................................................39Operation: get-client-hardware-os

...........................................................................................................................41Operation: add-client-to-policy

...........................................................................................................................43Operation: delete-client-from-policy

...........................................................................................................................45Job Operation

...........................................................................................................................45Operation: get-job-info

...........................................................................................................................50Backup Operations

...........................................................................................................................50Operation: manual-backup

...........................................................................................................................53Operation: client-backup

...........................................................................................................................57Restore Operations

...........................................................................................................................57Operation: normal-restore

Table of Contents 3

Version 1.0.00


...........................................................................................................................61Operation: archive-restore

...........................................................................................................................65Operation: true-image-restore

...........................................................................................................................70Operation: raw-partition-restore

...........................................................................................................................74Operation: snapshot-rollback-restore

...........................................................................................................................78Use Cases

...........................................................................................................................78Operation: test-client-backup-restore

Customer Support

5

Version 1.0.00


You can obtain technical support by using the Support page on the BMC Software Web site or bycontacting Customer Support by telephone or email. To expedite your inquiry, please see "BeforeContacting BMC Software."

Support Web Site

You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support_home. From this Web site, you can

Read overviews about support services and programs that BMC Software offers:

Find the most current information about BMC Software products

Search a database for problems similar to yours and possible solutions

Order or download product documentation

Report a problem or ask a question

Subscribe to receive email notices when new product versions are released

Find worldwide BMC Software support center locations and contact information, includingemail addresses, fax and telephone numbers

Support by Telephone or Email

In the United States and Canada, if you need technical support and do not have access to the Web,call 800 537 1813. Outside the United States and Canada, please contact your local support centerfor assistance. To find telephone and email contact information for the BMC Software support centerthat services your location, refer to the Contact Customer Support section of the Support page on theBMC Software Web site at http://www.bmc.com/support_home.

Before Contacting BMC Software

Before you contact BMC Software, have the following information available so that Customer Supportcan begin working on your problem immediately:

Product information

Product name

Product version (release number)

Operating system and environment information, machine type, operating system type, version,and service pack or other maintenance level, such as:

PUT or PTF

system hardware configuration

serial numbers

related software (database, application, and communication) including type, version, andservice

pack or maintenance

level

Sequence of events leading to the problem

Commands and options that you used

Messages received (and the time and date that you received them)

product error messages

messages from the operating system, such as "file system full"

messages from related software

http://www.bmc.com/support_home



Overview

7Actor Adapter

Version 1.0.00


Actor Adapter

An actor adapter performs specialized functions and serves as an interface to interact with externalsystems.

The actor adapter for Symantec NetBackup leverages Symantec NetBackup Master Server to interactwith Symantec NetBackup Clients.

Function of Actor Adapter in BMC Atrium Orchestrator

Getting Started

9Adapter Module Life Cycle

Version 1.0.00


Adapter Module Life Cycle

An adapter module contains a set of processes, schedules, rules, and configurations. You can createschedules and rules to trigger process execution. Each operation supported by the applicationadapter has a corresponding process in the adapter module. The figure below outlines the stepsrequired to work with an adapter module.

Adapter Module Life Cycle

No Monitor Adapter is available for Symantec NetBackup.

10Adapter Module Life Cycle

Version 1.0.00


Requirements

Supported versions of Symantec NetBackup

BMC Atrium Orchestrator Application Adapter for Symantec NetBackup supports the followingversions of Symantec NetBackup: 6.0 and higher.

Supported Operating Systems

BMC Atrium Orchestrator Application Adapter for Symantec NetBackup supports the followingoperating systems:

Windows

UNIX/Linux (HP-UX, Solaris and AIX).

Please note that for UNIX/Linux platforms, Sudo privileges are required to perform the followingNetBackup commands:

bppllist: lists policy information.

bpstulist: displays NetBackup storage units or storage unit groups.

bpbackup: backs up files to the NetBackup server.

bparchive: archives files to the NetBackup server.

bpflist: lists the backed up and archived files from a binary .f file on the NetBackup server.

bplist: lists the backed up and archived files on the NetBackup server.

bpplinfo: manages or displays policy attributes for NetBackup.

bpplclients: administers clients within NetBackup policies.

bptestbpcd: tests bpcd connections and verifies connect options.

bprestore: restores files from NetBackup Server.

bpps: lists all processes and statistics for each process.

bpgetconfig: provides configuration information.

Supported Versions of BMC Atrium Orchestrator

BMC Atrium Orchestrator Application Adapter for Symantec NetBackup supports BMC AtriumOrchestrator v7.6.2 and higher.

11Installing the Adapter

Version 1.0.00


Installing the Adapter

Getting the Adapter Package

The BMC Atrium Orchestrator Application Adapter for Symantec NetBackup can be obtained from Sentry Software Web site.

The package file name is: sentry-adapter-symantec-netbackup-<version>.zip. It contains the aroarpackages for both the UNIX/Linux and Windows systems, as well as the corresponding module (thatwill be loaded into Development Studio):

sentry-adapter-symantec-nbu-unix-actor_<version>.aroar (UNIX/Linux adapter)

sentry-adapter-symantec-nbu-windows-actor_<version>.aroar (Windows adapter)

AO-AD-Symantec_NetBackup.<version>.roar

The Windows adapter requires the peer to be running on a Windows environment.

Uploading the package (aroar) file in the BMC AtriumOrchestrator Repository1. Use your Web browser to connect to the BMC Atrium Orchestrator Grid Manager with

administrative credentials.

2. In the Manage tab, click the Upload Adapter button.

3. On the next page, select the Actor Adapter .aroar file to be uploaded and click OK.

Selecting the Actor Adapter to be uploaded

http://www.sentrysoftware.com


Version 1.0.00


4. The adapters are then listed in the BAO Grid Manager repository and ready to be added to theGrid and configured.

Adapters to be added to the Grid

If the Symantec NetBackup environment is a mixed environment (UNIX/Linux and Windows), both the SymantecNetBackup application adapter for Windows and UNIX must be configured for the targeted systems.


Version 1.0.00


Loading the module (roar) in BMC Atrium OrchestratorDevelopment Studio1. In the BMC Atrium Orchestrator Development Studio, switch to the Library Manager view.

2. Open the Import Modules tab and click the From Disk button.

3. Select the .roar file to be imported.

4. Click the checkbox Import and Unbundle and then click the Import button.

Loading the module

5. Switch to the Designer view, to visualize loaded module.

Visualizing the loaded module

14Configuring the Symantec NetBackup Adapter

Version 1.0.00


Configuring the SymantecNetBackup AdapterYou configure an adapter in the Grid Manager. The configuration provides information about how theadapter interacts with the Symantec NetBackup Master Server. While each adapter must have aunique name, you can create multiple adapters with the same adapter type to allow for differentconfiguration properties.

The form view provides an easy-to-use interface for configuring adapters. The form view preventshuman errors that might occur as a result of copying the configuration XML from the adapter userguide into the UI when configuring an adapter. You can switch to the XML view to configure thoseelements and attributes that are not available as fields or to configure all the elements and attributesusing XML only.

However, after you switch to the XML view, and save the configuration in the XML from that view,you cannot thereafter use the form view for modifying that configuration.

To configure the actor adapter1. Log on to the BMC Atrium Orchestrator Grid Manager.

2. Access the adapters page, by clicking the Manage tab; then click the Adapters tab.

3. In the Adapters in Repository list, select the check box corresponding to the type of adapterto be added.

4. Click Add to Grid to include the adapter in the Adapters on Grid list.

5. Click Configure corresponding to the newly added adapter.

6. On the Add an Adapter Configuration page, perform the following sub-steps to configure theadapter using the form view or jump to step 7 to configure the adapter using the XML view:

a. Enter a name for the adapter

b. Enter a description of the adapter

c. Under Properties, enter or select values for the configuration elements. Include all requiredelements indicated with an asterisk (*)

d. Click Switch to XML View and use the following steps to specify elements and attributesthat are not in the form view (Optional)

On the Warning message that appears, click Switch View

In the Properties text box, use XML format to enter the configuration elements andattributes not available as fields in the form view

Click OK.

7. Configure the adapter in the XML view using the following sub-steps:

a. Enter a name and a description of the adapter

b. Click Switch to XML View

c. On the Warning message that appears, click Switch View

d. Copy the configuration elements and attributes form the adapter user guide into the Properties text box, and then click OK.

e. On the Warning message that appears click Save. This saves the adapter configuration withsettings in the XML view permanently. The newly configured adapter is now listed in theAdapters on Grid list.


Version 1.0.00


Configuration Elements

The tables below describe the adapter configuration elements and attributes for the SymantecNetBackup actor adapter that you can specify using the form view, XML view, or both. You cannotuse the form view to configure elements and attributes that do not have an entry in the UI labelcolumn.

Please note that specifying these values in the adapter requests will overwrite the default elementssettings.

Configuration Elements for UNIX/Linux Environments

UI Label ElementNames

Definition Required

Target target The IP address of the Symantec NetBackup Master Server. Yes

Ssh-Port ssh-port Specifies the SSH port number.Default value: 22

No

User Name username Specifies the login name for the Symantec NetBackup MasterServer.This tag should not be used if the security file path is beingspecified using the <security-file-path> tag. In that case,username saved in the user defined security file or the defaultsecurity file is used.

Yes

Password password Specifies the password for the Symantec NetBackup MasterServer. You can encrypt the password by specifying theencryption type attribute.For example: <password encryption-type ="Base64">cGFzc3dvcmQ=</password>.

This tag should not be used if the security file path is beingspecified using the <security-file-path> tag. In that case,password saved in the user defined security file or the defaultsecurity file is used.

No

Private Key File private-key-file Specifies the path and file name of the local ssh key file. Thepath and file must exist on the peer servicing the adapterrequest. This element is used if the password element is notprovided.If password and private key file are both provided, thenprivate Key File approach is used and the password elementwill be ignored.

No

Pass Phrase pass-phrase Pass phrase for private key. No

Platform platform Specifies the platform on which the Symantec Netbackupmaster server is installed.

Valid values: Solaris, AIX, HP-UX, Linux

No

Installation Path installation-path The default installation path of the Symantec Netbackupmaster server.For example: /usr/openv or /opt/openv or /opt/VRTSnetbp

No

SUDO Privileges sudo-privilege Specifies whether the command must be executed with SUDOprivilege or not.

Default: No

No


Version 1.0.00



Definition Required

Timeout Secs timeout-secs Specifies the duration in seconds, after which timeout occurs.Default value: 180 seconds.

No

Example:

<configs> <config name="sofia"> <target>sofia</target> <port-ssh>22</port-ssh> <username>root</username> <password>password</password> <private-key-file>c:\private-key-dsa.pem</private-key-file> <passphrase>sentry</passphrase> <platform>Solaris</platform> <installation-path>/usr/openv</installation-path> <sudo-privilege>no</sudo-privilege> <timeout-secs>180</timeout-secs> </config></configs>

Configuration Elements for Windows Environments


Definition Required

Target target The IP address of the Symantec NetBackup Master Server. Yes

Login login Specifies the username used to connect to the SymantecNetbackup Master Server. The user account with rootprivileges must be configured in order to read and executeSymantec NetBackup application programs and access filesystems.For example: Domain\Username

Yes

Password password Specifies the password for the Symantec NetBackup MasterServer.

No

Timeout Secs timeout-secs Specifies the duration in seconds, after which timeout occurs.Default: 180 seconds

No

Example:

<configs> <config name="madrid"> <target>madrid</target> <username>madrid\administrator</username> <password>password</password> <timeout-secs>180</timeout-secs> </config></configs>

17Support for Multiple Configuration

Version 1.0.00


Support for Multiple Configuration

Symantec NetBackup adapter is capable of connecting to multiple Symantec NetBackup MasterServers. Each <config> is used to designate the connection criteria for a specific SymantecNetBackup Master Server. Each <config> element has a "name" attribute. This configuration name is used as a value for the<target> tag in adapter requests.

<config> <target>hostname</target> <username>username</username> <password>password</password> <protocol>http</protocol> <port>5989</port> <timeout-secs>200</timeout-secs></config>

The first configuration is also the default configuration.

The <configs> element is optional, but mandatory when more than one <config> node is defined.

Enabling the Debug Mode

If you encounter an issue and wish to report it to Sentry Software, you will be asked to enable theDebug Mode and provide the debug output to the Sentry Software Support team.

To enable the debug mode:

1. Browse to the ${catalina.home} path of the peer on which the workflow will be executed.

For example, if the adapter is loaded to peer CDP, the ${catalina.home} can be C:\BAO\BMCSoftware\AO\cdp\tomcat. Alternatively if the adapter is loaded to peer AP, the path can be C:\BAO\BMC Software\AO\ap\tomcat.

2. Then navigate to the webapps/bao<peer>/WEB-INF/classes sub-path, which is either webapps\baocdp\WEB-INF\classes or webapps\baoap\WEB-INF\classes depending on the selected peer

3. Open the file log4j.xml and set the below values

<appender class="org.apache.log4j.RollingFileAppender" name="sentryNBU"> <param name="File" value="${catalina.home}/logs/sen_nbu.log"/> <param name="Append" value="true"/> <param name="MaxFileSize" value="10240KB"/> <param name="MaxBackupIndex" value="5"/> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/> </layout> </appender>

<logger additivity="false" name="net.sentrysoftware.nbu"> <level value="info"/> <appender-ref ref="sentryNBU"/> </logger>

18Enabling the Debug Mode

Version 1.0.00


4. Once the above value is set in the log4j.xml file save and close the file.

5. Restart the appropriate peer in order to take into account the modification.

6. Now all the debug information will be stored in the file sen_nbu.log located under${catalina.home}\logs.

For example, C:\BAO\BMC Software\AO\cdp\tomcat\logs\sen_nbu.log or C:\BAO\BMC Software\AO\ap\tomcat\logs\sen_nbu.log depending on the selected peer.

Adapter Module

20

Version 1.0.00


Each operation supported by the application adapter has a corresponding process in the adaptermodule. Top-level processes perform high-level functions and call specialized processes insubdirectories. Each subdirectory contains process directories corresponding to the supportedoperation types.

SetupValidation

The processes in the SetupValidation directory contain sample values for the request elements.These sample values can be quickly changed to reflect the values in your environment. A process isprovided to test each supported method of executing operations in Symantec NetBackup MasterServer.

Utilities

The Utilities directory contains two types of helper processes:

General processes that perform validation and error checking

Processes that create the XML documents used in adapter requests

Processes are organized into subdirectories that correspond to the supported commands.

Version Directory

The v6.0 directory contains processes that require at least the Symantec NetBackup Master Serverv6.0.

In the current version of the Symantec NetBackup Storage adapter, there is only one version-specificdirectory (v6.0).

Later versions of the Symantec NetBackup Storage adapter may implement new processes that mightrequire the latest version of Symantec NetBackup Server, in which case these processes will begrouped into a separate directory.

Adapter Requests and Responses

22

Version 1.0.00


Typical Adapter Request

The typical adapter request specifies the operations to be performed with the operation-nameproperty of the nbu-request object. Additional information for the operation to be performed can beoptionally specified in the arguments collection.

<nbu-request> <operation-name>get-environment</operation-name> <arguments> <argument>..... </argument> </arguments></nbu-request>

Typical Adapter Response

The typical adapter response contains a metadata object reporting the success or failure of therequest. It also contains a single output object which itself contains various objects depending of therequest.

<nbu-request> <metadata> <status >success</status > <response-count>12</response-count> </metadata> <responses> <response> <metadata> <status /> <execution-milliseconds /> <line-count /> <target /> <config-name /> </metadata> <output> ..... </output> </response> </responses></nbu-request>

Symantec NetBackup Actor Adapter

The adapter requests for the actor adapter use a set of elements, operation-type and operation-name, in the adapter request node to execute an API call. The set of values used to make each APIcall is referred to as an operation.

You use the information in this chapter with Call Adapter Activity to create an adapter request. Fordetailed instructions about how to use the Call Adapter Activity, see the BMC Atrium OrchestratorDevelopment Studio User Documentation.

23Symantec NetBackup Actor Adapter

Version 1.0.00


The following table lists the process names and corresponding operations that can be performed bythis adapter:

Process name Adapter operation

Environment

Get Environment get-environment

Command

Nbu Execute nbu-execute

Policy

Get Policy get-policy

Activate Policy activate-policy

Deactivate Policy deactivate-policy

Client

Get Client get-client

Get Client Hardware OS get-client-hardware-os

Add Client to Policy add-client-to-policy

Delete Client from Policy delete-client-from-policy

Job

Get Job Info get-job-info

Backup

Manual Backup manual-backup

Client Backup client-backup

Restore

Normal Restore normal-restore

Archive Restore archive-restore

True Image Restore true-image-restore

Raw Partition Restore raw-partition-restore

Snapschot Rollback Restore snapshot-rollback-restore

Some Symantec NetBackup commands require SUDO privileges. For more information, refer to theRequirements section.

24Symantec NetBackup Actor Adapter

Version 1.0.00


Additional Information for Writing an AdapterRequest

Special characters used in a text field should be wrapped in the CDATA tag.Sample text: <![CDATA[sample(&*&$#$ t̂ext]]>

When executing a sample request from this user guide you must ensure that the supporting data ispresent in the Symantec NetBackup Master Server.

The execution of request may take time if the number of records associated with the query arelarge.

Environment Operation

Operation: get-environmentThe get-environment operation displays the complete environment details such as the server type,version, platform, installation path, binary path and the library path of the configured SymantecNetBackup server.

The table below describes the input properties for this request. If not specified, the valid value for anelement should be assumed to be any string.

Adapter Request Elements for 'get-environment'Operation

Definition Required

operation-name Specifies the name of the operation you want to perform.

Valid value: get-environment.

Yes

arguments Parent element for <argument> element. Yes

argument Specifies a list of arguments that is required for this operation. Yes

You can specify one or more of the following elements to retrieve specific information. If none of the elements is specified,then all the details are fetched.

target Specifies the name of the NetBackup Client. Make sure that the adapter configured platform is the same as the client’s one.Otherwise use the appropriate adapter based on the client’s platform.

No

username Specifies a user account with administrative privileges to read and execute SymantecNetBackup commands.For example:

On Windows system: Domain\Username

On UNIX and Linux system: Username

No

password Specifies the password for the NetBackup Client. No

ssh-port Specifies the client’s SSH port number. No

25Environment Operation

Version 1.0.00


Definition Required

Default value: 22

sudo-privilege Specifies whether the command on the client must be executed with SUDO privilege ornot. Refer to the Requirements section to know which NetBackup commands requireSUDO privilege.

Default value: None.

No

private-key-file Specifies the path and file name of the local ssh key file.The path and file must exist on the peer servicing the adapter request. This element isused if the password element is not provided.If password and private key file are both provided, then private key file approach is usedand the password element will be ignored.

No

pass-phrase Pass phrase for private key. No

installation-path Default installation path of the Symantec Netbackup Client.For example: /opt/openv or /usr/openv or /opt/VRTSnetbp

No

timeout-secs Specifies the time in seconds after which the attempt to connect to the Master Servertimes out. The "timeout-secs" specified in adapter request overrides the value specifiedin adapter configuration.

Valid value: A numeric value which specifies the time in seconds.

Default Value: 180, if no "timeout-secs" is provided in adapter configuration.

No

Sample Adapter Request for 'get-environment' Operation<nbu-request> <operation-name>get-environment</operation-name> <arguments> <argument> <target /> <username /> <password /> <private-key-file /> <passphrase /> <installation-path /> <sudo-privilege /> </argument> </arguments></nbu-request>

Sample Adapter Response for 'get-environment' Operation

Example for Windows:

<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>16084</execution-milliseconds> <line-count>44</line-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <nbu-environment> <environment> <nbu-server-type>NetBackup Master Server</nbu-server-type>


Version 1.0.00


<nbu-version>7.1</nbu-version> <platform>Windows</platform> <platform-version>Microsoft Windows Server 2008 R2 Standard</platform-version> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> <script-path-on-peer>D:\BMC Software\AO\cdp\server\grids\GRID1\library\adapters\implementations\sentry-adapter-symantec-nbu-windows-actor_1.0.00_35\</script-path-on-peer> <nbu-process-list> <nbu-process>vnetd</nbu-process> <nbu-process>bpinetd</nbu-process> <nbu-process>bpcd</nbu-process> <nbu-process>nbevtmgr</nbu-process> <nbu-process>dbsrv11</nbu-process> <nbu-process>nbemm</nbu-process> <nbu-process>nbrb</nbu-process> <nbu-process>vmd</nbu-process> <nbu-process>ltid</nbu-process> <nbu-process>nbrmms</nbu-process> <nbu-process>nbaudit</nbu-process> <nbu-process>bpdbm</nbu-process> <nbu-process>bpjobd</nbu-process> <nbu-process>bpcompatd</nbu-process> <nbu-process>bprd</nbu-process> <nbu-process>nbjm</nbu-process> <nbu-process>nbpem</nbu-process> <nbu-process>nbsl</nbu-process> <nbu-process>nbproxy</nbu-process> <nbu-process>nbproxy</nbu-process> <nbu-process>nbvault</nbu-process> <nbu-process>nbstserv</nbu-process> <nbu-process>nbars</nbu-process> <nbu-process>nbsvcmon</nbu-process> <nbu-process>bmrd</nbu-process> <nbu-process>nbproxy</nbu-process> <nbu-process>avrd</nbu-process> <nbu-process>bpdbm</nbu-process> <nbu-process>nbproxy</nbu-process> <nbu-process>NBConsole</nbu-process> <nbu-process>nbproxy</nbu-process> <nbu-process>nbproxy</nbu-process> <nbu-process>bpps</nbu-process> </nbu-process-list> </environment> </nbu-environment> </output> </response> </responses></nbu-response>


Version 1.0.00


Example for UNIX/Linux:

<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>5085</execution-milliseconds> <line-count>52</line-count> <target>sofia</target> <config-name>default</config-name> </metadata> <output> <nbu-environment> <environment> <nbu-server-type>Master</nbu-server-type> <nbu-version>7.5.0.0.0.4</nbu-version> <platform>Solaris</platform> <platform-version>Solaris10</platform-version> <nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> <nbu-library-path>/usr/openwin/lib</nbu-library-path> </nbu-library-paths> <nbu-process-list> <nbu-process>/usr/openv/netbackup/bin/bprd</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bprd</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bprd</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpjava-susvc root -1 -1 C /usr/openv/java/auth.conf 1 </nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpjava-susvc root -1 -1 C /usr/openv/java/auth.conf 1 </nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpjava-susvc root -1 -1 C /usr/openv/java/auth.conf 1 </nbu-process> <nbu-process>/opt/openv/java/jre/bin/sparcv9/java -Dvrts.NBJAVA_CONF=/usr/openv/java/nbj.con</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbars</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bptm -delete_all_expired 1>/dev/null 2>/dev/null</nbu-process> <nbu-process>/usr/openv/db//bin/NB_dbsrv @/usr/openv/var/global/server.conf @/usr/openv/var/</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbsl</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbrb</nbu-process> <nbu-process>/usr/openv/netbackup/bin/admincmd/bpstsinfo -UPDATE</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy dblib -mgrIORFile -PolicyManager-1.ior.mgr -pr</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpcd -standalone</nbu-process> <nbu-process>/usr/openv/netbackup/bin/vnetd -standalone</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpjava-susvc root -1 -1 C /usr/openv/java/auth.conf 1 </nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy" dblib -mgrIORFile -PolicyManager-1.ior</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpjobd</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbvault</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy dblib nbjm</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bptm -delete_all_expired</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpcd -standalone</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy dblib -mgrIORFile -StorageService-1.ior.mgr -p</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbcssc -a NetBackup</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbpem</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpcompatd</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbsvcmon</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bpdbm</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbim</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy dblib nbpem_cleanup</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy" dblib -mgrIORFile -StorageService-1.io</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy dblib nbpem</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbaudit</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbproxy dblib nbpem_email</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbevtmgr</nbu-process> <nbu-process>/usr/openv/netbackup/bin/bprd</nbu-process>


Version 1.0.00


<nbu-process>/usr/openv/netbackup/bin/nbstserv</nbu-process> <nbu-process>/usr/openv/netbackup/bin/nbjm</nbu-process> </nbu-process-list> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Command Operation

Operation: nbu-executeThe nbu-execute operation is used to execute any generic Symantec NetBackup commands on theconfigured system.


Adapter Request Elements for 'nbu-execute' Operation

Definition Required


Valid value: nbu-execute.

Yes



nbu-command Specifies the command to be executed. Yes

Sample Adapter Request for 'nbu-execute' Operation<nbu-request> <operation-name>nbu-execute</operation-name> <arguments> <argument> <nbu-command>bppllist -L</nbu-command > </argument> </arguments> </nbu-request>

Adapter Response Elements for 'nbu-execute' Operation

Description

nbu-command Command that was executed.

command-ouput Output of the command.

nbu-server-type Specifies whether it is a Symantec NetBackup Master Server, Media Server or Client.

29Command Operation

Version 1.0.00


platform Specifies the platform of the NetBackup Master Server, Media Server or Client.

nbu-install-path Specifies the installation path of the NetBackup Master Server, Media Server or Client.

script-path-on-peer Specifies the vbs script path installed on the BMC Orchestrator Application Adapter peer.

nbu-binary-path Specifies the path where the binary files of the NetBackup Master Server, Media Server orClient are installed.

nbu-library-path Specifies the path where the library files of the NetBackup Master Server, Media Server or Cientare installed.

30Command Operation

Version 1.0.00


Sample Adapter Response for 'nbu-execute' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>2340</execution-milliseconds> <line-count>13</line-count> <target>sofia</target> <config-name>default</config-name> </metadata> <output> <commands> <command> <nbu-command>bppllist -L</nbu-command> <command-output>Policy: bao-test-policyPolicy: catalog-backupPolicy: frequent_policyPolicy: installPolicy: ndmp-netappPolicy: snapshot-policyPolicy: test-backupPolicy: test-backup-storagePolicy: test-vm

</command-output> </command> </commands> <nbu-environment> <environment name="default"> <nbu-server-type>Master</nbu-server-type> <platform>unix</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> <nbu-library-path>/usr/openwin/lib</nbu-library-path> </nbu-library-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Policy Operations

The following Policy operations are supported:

get-policy, to list all the policies defined in the Symantec NetBackup Master Server.activate-policy, to activate a policy.deactivate-policy, to deactivate a policy.

31Policy Operations

Version 1.0.00


Operation: get-policyThe get-policy operation lists all the policies defined in the Symantec NetBackup Master Server.


Adapter Request Elements for 'get-policy' Operation

Definition Required


Valid value: get-policy.

Yes



policy-name Specifies the user defined policy name. No

Sample Adapter Request for 'get-policy' Operation<nbu-request> <operation-name>get-policy</operation-name> <arguments> <argument> <policy-name /> </argument> </arguments> </nbu-request>

Adapter Response Elements for 'get-policy' Operation

Description

policy-name Name of the Symantec NetBackup policy.

policy-type Type of the policy.

policy-type-code Unique code that represents the policy type.

policy-priority Priority of the policy.

is-active Possible values are yes (is active) or no (is not active).

effective-date Date from which the policy takes effect.

effective-date-epoch The epoch time from which the policy takes effect.

residence Label of the storage unit used by the policy.

volume-pool Volume pool of the policy.

keyword Keyword used by the policy to associate all its backups.

client-name Name of the client associated to the policy.

schedule-name Name of the schedule associated to the policy.

32Policy Operations

Version 1.0.00


Description

schedule-type Type of the schedule.

schedule-type-code Unique code that represents the schedule type.

schedule-daily-window Daily window of the schedule.

nbu-server-type Specifies whether it is a NetBackup Master Server, Media Server or Client.




bu-binary-path Specifies the path where the binary files of the NetBackup Master Server, Media Server or Clientare installed.

nbu-library-path Specifies the path where the library files of the NetBackup Master Server, Media Server or Cientare installed.

Sample Adapter Response for 'get-policy' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>44898</execution-milliseconds> <line-count>107</line-count> <policy-count>9</policy-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <policies> <policy> <policy-name>catalog_bkp</policy-name> <policy-type>NBU-Catalog (35)</policy-type> <policy-priority>0</policy-priority> <active>yes</active> <effective-date>01/22/2012 22:36:43</effective-date> <volume-pool>CatalogBackup</volume-pool> <clients> <client-name hardware="PC-x64" os="Windows7" priority="0">madrid.sentrysoftware.net</client-name> <client-name hardware="unknown" os="unknown" priority="0">madrid</client-name> <client-name hardware="unknown" os="unknown" priority="0">pythagoras-p27p</client-name> </clients> <schedules> <schedule> <schedule-name>Full</schedule-name> <schedule-type>FULL</schedule-type> <schedule-type-code>0</schedule-type-code> </schedule> <schedule> <schedule-name>Differential-Inc</schedule-name> <schedule-type>INCR</schedule-type> <schedule-type-code>1</schedule-type-code> <schedule-daily-window>Day Open Close W-Open W-Close Sunday 000:00:00 024:00:00 000:00:00 024:00:00 Monday 000:00:00 024:00:00 024:00:00 048:00:00 Tuesday 000:00:00 024:00:00 048:00:00 072:00:00 Wednesday 000:00:00 024:00:00 072:00:00 096:00:00 Thursday 000:00:00 024:00:00 096:00:00 120:00:00 Friday 000:00:00 024:00:00 120:00:00 144:00:00 Saturday 000:00:00 024:00:00 144:00:00 168:00:00

33Policy Operations

Version 1.0.00


</schedule-daily-window> </schedule> </schedules> </policy> <policy> <policy-name>test</policy-name> <policy-type>MS-Windows (13)</policy-type> <policy-priority>0</policy-priority> <active>yes</active> <effective-date>01/25/2013 15:49:41</effective-date> <volume-pool>NetBackup</volume-pool> </policy> <policy> <policy-name>testpolicy</policy-name> <policy-type>Standard (0)</policy-type> <policy-priority>0</policy-priority> <active>no</active> <effective-date>01/01/1970 01:00:00</effective-date> <volume-pool>NetBackup</volume-pool> <clients> <client-name hardware="Windows-x64" os="Windows2008" priority="0">madrid</client-name> <client-name hardware="Windows-x86" os="Windows7" priority="0">comte</client-name> <client-name hardware="Windows-x86" os="Windows7" priority="0">pythagoras-p27p</client-name> </clients> <schedules> <schedule> <schedule-name>DailyInc</schedule-name> <schedule-type>CINC</schedule-type> <schedule-type-code>4</schedule-type-code> <schedule-daily-window>Day Open Close W-Open W-Close Sunday 023:00:00 033:00:00 023:00:00 033:00:00 Monday 023:00:00 033:00:00 047:00:00 057:00:00 Tuesday 023:00:00 033:00:00 071:00:00 081:00:00 Wednesday 023:00:00 033:00:00 095:00:00 105:00:00 Thursday 023:00:00 033:00:00 119:00:00 129:00:00 Friday 000:00:00 000:00:00 Saturday 023:00:00 033:00:00 167:00:00 177:00:00 09:00:00 </schedule-daily-window> </schedule> </schedules> </policy> </policies> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: activate-policyThe activate-policy operation is used to activate a policy.


34Policy Operations

Version 1.0.00


Adapter Request Elements for 'activate-policy'Operation

Definition Required


Valid value: activate-policy.

Yes



policy-name Specifies the policy name to activate. Yes

Sample Adapter Request for 'activate-policy' Operation<nbu-request> <operation-name>activate-policy</operation-name> <arguments> <argument> <policy-name> testpolicy</policy-name> </argument> </arguments> </nbu-request>

Adapter Response Elements for 'activate-policy'Operation

Description

policy-name Name of the activated policy.

policy-status Status of the policy. The possible values are active or inactive.





nbu-binary-path Specifies the path where the binary files of the NetBackup Master Server, Media Server or Client areinstalled.

nbu-library-path Specifies the path where the library files of the NetBackup Master Server, Media Server or Cient areinstalled.

Sample Adapter Response for 'activate-policy' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>4270</execution-milliseconds>

35Policy Operations

Version 1.0.00


<line-count>10</line-count> <policy-count>0</policy-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <policies> <policy> <policy-name>testpolicy</policy-name> <policy-status>active</policy-status> </policy> </policies> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: deactivate-policyThe deactivate-policy operation is used to deactivate a policy.


Adapter Request Elements for 'deactivate-policy'Operation

Definition Required


Valid value: deactivate-policy.

Yes



policy-name Specifies the policy name to deactivate. Yes

Sample Adapter Request for 'deactivate-policy' Operation<nbu-request> <operation-name>deactivate-policy</operation-name> <arguments> <argument> <policy-name> testpolicy</policy-name> </argument> </arguments> </nbu-request>

36Policy Operations

Version 1.0.00


Adapter Response Elements for 'deactivate-policy'Operation

Description

policy-name Name of the deactivated policy.

policy status Status of the policy. The possible values are active or inactive.







Sample Adapter Response for 'deactivate-policy' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>4270</execution-milliseconds> <line-count>10</line-count> <policy-count>0</policy-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <policies> <policy> <policy-name>testpolicy</policy-name> <policy-status>inactive</policy-status> </policy> </policies> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

37Client Operations

Version 1.0.00


Client Operations

The following Client operations are supported:

get-client, to list all the Symantec NetBackup clients that are associated to the policy.get-client-hardware-os, to list all the supported hardware types and operating systems of aNetBackup Client.add-client-to-policy, to add a client or a list of clients to a specified policy or to all the policies.delete-client-from-policy, to delete a client or a list of clients from the specified policy.

Operation: get-clientThe get-client operation lists all the Symantec NetBackup clients that are associated to the policy.


Adapter Request Elements for 'get-client' Operation

Definition Required


Valid value: get-client.

Yes



client-name Displays the complete information of the specified client(s). If not specified,information about all the available clients is displayed.

No

Sample Adapter Request for 'get-client' Operation<nbu-request> <operation-name>get-client</operation-name> <arguments> <argument> <client-name>comte</client-name> </argument> </arguments> </nbu-request>

38Client Operations

Version 1.0.00


Adapter Response Elements for 'get-client' Operation

Description

client-name Name of the client.

hardware Hardware type of the client.

os Platform of the client.

priority Priority of the client.

policy-name Name(s) of the policy to which the client is associated.







Sample Adapter Response for 'get-client' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>8689</execution-milliseconds> <line-count>15</line-count> <client-count>1</client-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <clients> <client> <client-name>comte</client-name> <hardware>Windows-x86</hardware> <os>Windows2003</os> <priority>0</priority> <policy-names> <policy-name>install</policy-name> <policy-name>test2</policy-name> <policy-name>testpolicy</policy-name> </policy-names> </client> </clients> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\ sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path>

39Client Operations

Version 1.0.00


<nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: get-client-hardware-osThe get-client-hardware-os operation lists all the supported hardware types and operatingsystems of a NetBackup Client.


Adapter Request Elements for 'get-client-hardware-os'Operation

Definition Required


Valid value: get-client-hardware-os.

Yes




hardware Specifies the user defined hardware. No

os Specifies the user defined operating system. No

40Client Operations

Version 1.0.00


Sample Adapter Request for 'get-client-hardware-os' Operation<nbu-request> <operation-name>get-client-hardware-os</operation-name> <arguments> <argument> <hardware /> <os /> </argument> </arguments> </nbu-request>

Adapter Response Elements for 'get-client-hardware-os'Operation

Description

hardware Type of the hardware.

os Name of the operating system.

nbu-server-type Specifies whether it is a NetBackup Master Server, Media Server or Client




nbu-binary-path Specifies the path where the binary files of the NetBackup Master Server, Media Server or Clientare installed.


Sample Adapter Response for 'get-client-hardware-os' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>4259</execution-milliseconds> <line-count>88</line-count> <hardware-os-count>40</hardware-os-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <hardware-os-details> <hardware-os-detail> <hardware>HP-UX-IA64</hardware> <os>HP-UX11.31</os> </hardware-os-detail> <hardware-os-detail> <hardware>HP9000-700</hardware> <os>HP-UX11.23</os> </hardware-os-detail> <hardware-os-detail> <hardware>HP9000-700</hardware> <os>HP-UX11.31</os> </hardware-os-detail>

41Client Operations

Version 1.0.00


<hardware-os-detail> <hardware>HP9000-800</hardware> <os>HP-UX11.11</os> </hardware-os-detail> <hardware-os-detail> <hardware>HP9000-800</hardware> <os>HP-UX11.23</os> </hardware-os-detail> <hardware-os-detail> <hardware>OpenVMS</hardware> <os>OpenVMS_VAX</os> </hardware-os-detail> <hardware-os-detail> <hardware>RS6000</hardware> <os>AIX53</os> </hardware-os-detail> <hardware-os-detail> <hardware>Solaris</hardware> <os>Solaris10</os> </hardware-os-detail> <hardware-os-detail> <hardware>Solaris</hardware> <os>Solaris9</os> </hardware-os-detail> <hardware-os-detail> <hardware>Windows-IA64</hardware> <os>WindowsXP</os> </hardware-os-detail> <hardware-os-detail> <hardware>Windows-x86</hardware> <os>Windows2008</os> </hardware-os-detail> <hardware-os-detail> <hardware>Windows-x86</hardware> <os>Windows7</os> </hardware-os-detail> <hardware-os-detail> <hardware>Windows-x86</hardware> <os>WindowsVista</os> </hardware-os-detail> <hardware-os-detail> <hardware>Windows-x86</hardware> <os>WindowsXP</os> </hardware-os-detail> </hardware-os-details> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: add-client-to-policyThe add-client-to-policy operation is used to add a client or a list of clients to a specified policy orto all the policies.

The table below describes the input properties for this request. If not specified, the valid value for an

42Client Operations

Version 1.0.00


element should be assumed to be any string.

Adapter Request Elements for 'add-client-to-policyOperation

Definition Required


Valid value: add-client-to-policy

Yes




client-name Specifies the client name(s) to be added to the policy. Yes

policy-nameSpecifies the policy name to which a client or a list of clients will be added.If not specified, the client(s) will be added to all the available policies.

No

Sample Adapter Request for 'add-client-to-policy' Operation<nbu-request> <operation-name>add-client-to-policy</operation-name> <arguments> <argument> <policy-name>testpolicy</policy-name> <client-name hardware="Windows-x86" os="Windows7" priority="0">pythagoras-p27p</client-name> </argument> </arguments> </nbu-request>

Adapter Response Elements for 'add-client-to-policy'Operation

Description

policy-name The name(s) of the Policy to which the client(s) were added.

client-name The name of the client(s) that were added to the policy.

add-status Indicates the status of the operation.






43Client Operations

Version 1.0.00



Sample Adapter Response for 'add-client-to-policy' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>14524</execution-milliseconds> <line-count>11</line-count> <policy-count>1</policy-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <policies> <policy> <policy-name>testpolicy</policy-name> <client-name hardware="Windows-x86" os="Windows7" priority="0">pythagoras-p27p</client-name> <add-status>success</add-status> </policy> </policies> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: delete-client-from-policyThe delete-client-from-policy is used to delete a client or a list of clients from the specifiedpolicy.


Adapter Request Elements for 'delete-client-from-policy' Operation

Definition Required

operation-name Specifies the name of the operation you want to perform. Yes

44Client Operations

Version 1.0.00


Definition Required

Valid value: delete-client-from-policy.




client-name Specifies the client name(s) to be deleted from the policy. Yes

policy-nameSpecifies the policy name from which a client or a list of clients to be deleted. If notspecified, the client(s) will be deleted from all the available policies.

No

Sample Adapter Request for 'delete-client-from-policy' Operation<nbu-request> <operation-name>delete-client-from-policy</operation-name> <arguments> <argument> <policy-name>testpolicy</policy-name> <client-name>pythagoras-p27p</client-name> </argument> </arguments> </nbu-request>

Adapter Response Elements for 'delete-client-from-policy' Operation

Description

policy-name The name of the Policy from which the client or list of clients was deleted.

client-name The name of the client(s) that was deleted from the policy.

delete-status Indicates the status of the operation.




script-path-on-peer

Specifies the vbs script path installed on the BMC Orchestrator Application Adapter peer.



Sample Adapter Response for 'delete-client-from-policy' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count>

45Client Operations

Version 1.0.00


</metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>8518</execution-milliseconds> <line-count>11</line-count> <policy-count>1</policy-count> <target>madrid</target> <config-name>default</config-name> </metadata> <output> <policies> <policy> <policy-name>testpolicy</policy-name> <client-name>pythagoras-p27p</client-name> <delete-status>success</delete-status> </policy> </policies> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Master Server</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\BMC\sentry-adapter-symantec-nbu-windows-actor\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\admincmd</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin\goodies</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\volmgr\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Job Operation

Operation: get-job-infoThe get-job-info operation lists the information about all the jobs present in the Netbackupdatabase.


Adapter Request Elements for 'get-job-info' Operation

Definition Required


Valid value: get-job-info.

Yes



46Job Operation

Version 1.0.00


Definition Required


job-id Specifies the user defined unique Job ID. No

job-type

or

job-type-code

Specifies the unique type or code of the job.Valid values:

backup (0)archive (1)restore (2)verify (3)duplicate (4)import (5)catalog backup (6)vault (7)label (8)erase (9)tape request (10)tape clean (11)format tape (12)physical inventory (13)qualification (14)database recovery (15)media contents (16)image delete (17)LiveUpdate (18)

No

master-server-name Specifies the user defined master server name. No

policy-name Specifies the name of the NetBackup policy. No

client-name Specifies the name of the NetBackup Client. No

start-date-range Specifies only the job records modified since this timestamp. The output list showsonly job records that occurred at or after the specified date and time. The requireddate and time format varies according to your locale.

Valid format: mm/dd/yyyy HH:MM:SSThe default start date is 01/01/1970 00:00:00

No

start-date-range-epoch

Specifies the user defined extent pool name.Valid value: Any valid string.

Default value: None.

No

end-date-range Specifies an end date and time for the listing. The output list shows only files frombackups or the archives that occurred at or before the specified date and time. Usethe same format as for the start date and time.

Valid format: mm/dd/yyyy HH:MM:SSDefault value: current date and time.

No

end-date-range-epoch

Specifies an end date and time in epoch for the listing. The output list shows jobrecords that occurred at or before the specified seconds.

No

Sample Adapter Request for 'get-job-info' Operation<nbu-request> <operation-name>get-job-info</operation-name> <arguments> <argument> <job-id /> <job-type /> <job-type-code /> <master-server-name /> <client-name />

47Job Operation

Version 1.0.00


<policy-name /> <start-date-range /> <start-date-range-epoch /> <end-date-range /> <end-date-range-epoch /> </argument> </arguments> </nbu-request>

48Job Operation

Version 1.0.00


Adapter Response Elements for 'get-job-info' Operation

Description

job-id Unique identifier of the Job.

job-type

or

job-type-code

Type of the job.Valid values:

job-type job-type-code

backuparchiverestoreverifyduplicateimportcatalog backupvaultlabelerasetape requesttape cleanformat tapephysical inventoryqualificationdatabase recoverymedia contentsimage deleteLiveUpdate

0 (backup)1 (archive)2 (restore)3 (verify)4 (duplicate)5 (import)6 (catalog backup)7 (vault)8 (label)9 (erase)10 (tape request)11 (tape clean)12 (format tape)13 (physical inventory)14 (qualification)15 (database recovery)16 (media contents)17 (image delete)18 (LiveUpdate)

policy-name Name of the NetBackup policy.

master-server-name Name of the Master Server.

client-name Name of the client.

schedule-type Type of the schedule.

schedule-type-code Unique code that represents the schedule type.

start-date-range Specifies the starting date of the Job.


Specifies the starting date of the Job in epoch.

end-date-range Specifies the ending date of the Job.


Specifies the ending date of the Job in epoch.

elapsed-time-seconds

Specifies the job elapsed time in seconds.

job-status Status of the job.Valid value: queued, active, wait for retry, done, suspended, incomplete

job-complete-percent

Specifies the job completion percentage.


platform Specifies the platform of the NetBackup Master Server, Media Server or Client..


49Job Operation

Version 1.0.00


Description




Sample Adapter Response for 'get-job-info' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>2106</execution-milliseconds> <line-count>26</line-count> <job-count>1</job-count> <target>sofia</target> <config-name>default</config-name> </metadata> <output> <jobs> <job> <job-id>14072</job-id> <job-type>backup</job-type> <job-type-code>0</job-type-code> <master-server-name>sofia</master-server-name> <policy-name>ndmp-netapp</policy-name> <client-name>netapp2-san-00</client-name> <schedule-type>FULL</schedule-type> <schedule-type-code>0</schedule-type-code> <start-date-range>11/06/2013 00:45:01</start-date-range> <start-date-range-epoch>1383695101</start-date-range-epoch> <end-date-range>11/06/2013 00:54:20</end-date-range> <end-date-range-epoch>1383695660</end-date-range-epoch> <elapsed-time-seconds>0.559</elapsed-time-seconds> <job-status>done</job-status> <job-complete-percent>100</job-complete-percent> </job> </jobs> <nbu-environment> <environment name="default"> <nbu-server-type>Master</nbu-server-type> <platform>unix</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> <nbu-library-path>/usr/openwin/lib</nbu-library-path> </nbu-library-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

50Backup Operations

Version 1.0.00


Backup Operations

The following Backup operations are supported:

manual-backup, to start an immediate manual backup of a client associated to a policy orimmediately run the schedule that is associated with the disk staging storage unit (dssu).

client-backup, to start a user backup equivalent to what is performed by using the interface onthe client.

Operation: manual-backupThe manual-backup operation starts an immediate manual backup of a client associated to a policyor immediately runs the schedule that is associated with the disk staging storage unit (dssu).

Only Master Server administrators can perform this operation


Adapter Request Elements for 'manual-backup'Operation

Definition Required


Valid value: manual-backup.

Yes




policy-nameordisk-staging-storage-unit-name

Specifies the policy name to use for the backup.

Specifies the Disk Staging Storage Unit (DSSU) to use for the backup.

Yes

master-server-name

Specifies the name(s) of the master server.Default value:

On UNIX and Linux systems, the first SERVER entry specified in the /usr/openv/netbackup/bp.conf file.On Windows systems, the server designated as current on the Servers tab.

No

client-nameSpecifies the client names to use for manual backup.If not specified, all clients in the policy will be backed up. This option is valid if thepolicy-name is specified.

No

policy-type orpolicy-type-code

Specifies the policy type for which the backups were performed.Default values:

No

51Backup Operations

Version 1.0.00


Definition Required

On UNIX and Linux systems, the default value for policy-type=Standard and forpolicy-type=0.On Windows systems, the default value for policy-type=MS-Windows and for policy-type=13.

Valid values:

policy-type policy-type-code

StandardOracleInformix-On-BARSybaseMS-SharePointNetWareDataTools-SQL-BackTrack MS-WindowsOS/2 MS-SQL-ServerMS-Exchange-ServerSAPDB2NDMPFlashBackupSplit-MirrorAFSLotus-NotesVaultNBU-CatalogPureDisk-ExportEnterprise-VaultVMwareMS-Hyper-V

0467810111314151617181920212225303538394041

schedule-name Specifies the schedule name to use for the backup. If not specified, the firstavailable schedule currently in use specified in the policy will be used. This option isvalid if the policy-name is specified.

No

keyword Specifies a keyword phrase that will be associated with the image created by thisbackup operation. This may be helpful while restoring an image by just specifyingthe keyword phrase. The keyword phrase is a textual description of the backup that is a maximum of 128characters in length.The default keyword phrase is the null (empty) string.This option is valid if the policy-name is specified.

No

additional-options Specifies the additional options that are not specified in this manual-backup processtable.

No

progress-log-file-path Specifies the name of a file in which the backup progress information is written.NetBackup creates the file if it does not exist. This option is valid if the policy-nameis specified. By default the progress log will be created on the individual clients at:

install_path\NetBackup\logs\bpbackup\ (Windows systems)usr/openv/netbackup/logs/bpbackup/ (UNIX and Linux systems)

For example:On Windows system: c:\proglogOn UNIX and Linux system: /home/tlc/proglog

No

Sample Adapter Request for 'manual-backup' Operation<request-data> <nbu-request>

52Backup Operations

Version 1.0.00


<operation-name>client-backup</operation-name> <arguments> <argument> <client-name>comte</client-name> <policy-name>bao-test-policy</policy-name> <policy-type-code>13</policy-type-code> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <keyword>bp_test_compte</keyword> <file-path>C:\NBU Test\Files to backup</file-path> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Client</nbu-server-type> <platform>Windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\BMC Software\AO\cdp\server\grids\GRID1\library\adapters\implementations\sentry-adapter-symantec-nbu-windows-actor_1.0.00_35\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </argument> </arguments> </nbu-request></request-data>

Adapter Response Elements for 'manual-backup'Operation

Description

backup-status Specifies the status of the backup operation.




script-path-on-peer




Sample Adapter Response for 'manual-backup' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>57877</execution-milliseconds> <line-count>16</line-count> <target>comte</target> <config-name>default</config-name> </metadata> <output> <backups> <backup>

53Backup Operations

Version 1.0.00


<client-name>comte</client-name> <policy-name>bao-test-policy</policy-name> <policy-type>MS-Windows</policy-type> <policy-type-code>13</policy-type-code> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <keyword>bp_test_compte</keyword> <file-path>C:\NBU Test\Files to backup</file-path> <archive>No</archive> <backup-status>initiated successfully</backup-status> </backup> </backups> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Client</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\BMC Software\AO\cdp\server\grids\GRID1\library\adapters\implementations\sentry-adapter-symantec-nbu-windows-actor_1.0.00_35\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: client-backupThe client-backup operation starts a user backup similar to the one performed through the clientinterface.This type of backup can be started from any NetBackup Client to back up a file or list of files fromthat client. This operation is performed on the NetBackup Client system.


Adapter Request Elements for 'client-backup' Operation

Definition Required


Valid value: client-backup.

Yes




client-name Specifies the client name from which the files are to be backed up. No

username

Specifies a user account with administrative privileges to read and executeSymantec NetBackup commands. If the client name is different from the adapterconfiguration target name then this value must be specified.

For example:On Windows system: Domain\UsernameOn UNIX and Linux system: Username

No

54Backup Operations

Version 1.0.00


Definition Required


use-config-credentials Specifies whether to use the adapter configuration credentials for connecting tothe client or not.

Valid values: Yes | NoDefault value: No

No

ssh-port Specifies the client’s SSH port number.

Default value: 22

No

sudo-privilege Specifies whether the command on the client must be executed with SUDOprivilege or not.

Defaul value: No

No

private-key-file Specifies the path and file name of the local ssh key file. The path and file mustexist on the peer servicing the adapter request. This element is used if the password element is not provided. If both password and private key file are provided, then private key file approachis used and the password element will be ignored.

No

pass-phrase Pass phrase for private key No

installation-path The default installation path of the Symantec Netbackup Client.For example: /opt/openv or /usr/openv or /opt/VRTSnetbp

No

file-path

or

file-list-path

Specifies a path to the file that must be backed up. A file path can be a file nameor a directory name. If the named files include a directory, it backs up all files andsubdirectories of that directory i.e. it starts at the directory itself.

For example:On UNIX and Linux system: /home, /tmp/backup.logOn Windows system: C:\Programs, c:\backup.log

Specifies a path to the file (list file) that contains a list of files to be backed up.This file must exist on the adapter configured target system.

For example:On UNIX and Linux system: /tmp/backupFileList.txtOn Windows system: C:\backupFileList.txt

Yes

master-server-name Specifies the name(s) of the master server.Default value:


No

policy-name Specifies the policy name to use for the backup.If not specified, NetBackup uses the first policy it finds that includes the client.

No



On UNIX and Linux systems, the default value for policy-type=Standard and forpolicy-type=0.On Windows systems, the default value for policy-type=MS-Windows and forpolicy-type=13.

Valid values:


StandardOracleInformix-On-BARSybaseMS-SharePoint

04678

No

55Backup Operations

Version 1.0.00


Definition Required


NetWareDataTools-SQL-BackTrack MS-WindowsOS/2 MS-SQL-ServerMS-Exchange-ServerSAPDB2NDMPFlashBackupSplit-MirrorAFSLotus-NotesVaultNBU-CatalogPureDisk-ExportEnterprise-VaultVMwareMS-Hyper-V

10111314151617181920212225303538394041

schedule-name Specifies the schedule name to use for the backup. If not specified, NetBackupuses the first user backup schedule it finds for the client in the policy currently inuse.

No

keyword Specifies a keyword phrase associated with the image created by this backupoperation. This may be helpful while restoring an image by just specifying thekeyword phrase. The keyword phrase is a textual description of the backup that is a maximum of128 characters in length.The default keyword phrase is the null (empty) string.

No

progress-log-file-path Specifies the name of a file in which the backup progress information is written.NetBackup creates the file if it does not exist. By default the progress log will becreated on the individual clients.

For example:On Windows system: c:\proglog.logOn UNIX and Linux system: /home/tlc/proglog.log

No

additional-options Specifies the additional options that are not specified in this client-backup processtable.

No

archive Specifies the files to be archived. The files will be deleted after archivedsuccessfully.


No

Sample Adapter Request for 'client-backup' Operation<request-data> <nbu-request> <operation-name>client-backup</operation-name> <arguments> <argument> <client-name>wellington</client-name> <use-config-credentials>yes</use-config-credentials> <file-path>/etc/init.d/netbackup</file-path> <main-operation-name>client-backup</main-operation-name> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type>

56Backup Operations

Version 1.0.00


<platform>Linux</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <script-path-on-peer /> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </argument> </arguments> </nbu-request></request-data>

Adapter Response Elements for client-backup'Operation

Description

backup-status Specifies the status of the backup operation




script-path-on-peer




Sample Adapter Response for 'client-backup' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>46988</execution-milliseconds> <line-count>14</line-count> <target>wellington</target> <config-name>default</config-name> </metadata> <output> <backups> <backup> <client-name>wellington</client-name> <file-path>/etc/init.d/netbackup</file-path> <archive>No</archive> <backup-status>initiated successfully</backup-status> </backup> </backups> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type>

57Backup Operations

Version 1.0.00


<platform>unix</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Restore Operations

The following Restore operations are supported:

normal-restore, to restore files from a normal backup. The operation starts a restore similar tothe one performed through the client interface.

archive-restore, to restore files from an archived backup. The operation starts a restore similarto the one performed through the client interface.

true-image-restore, to restore the files and the directories that existed in the last true-imagebackup. This process is useful only if true-image backups were performed.

raw-partition-restore, to restore raw partitions (UNIX and Linux systems) or disk images(Windows systems) instead of the complete file systems.

snapshot-rollback-restore, to restore the files using snapshot backups.

Operation: normal-restoreThe normal-restore operation is used to restore files from a normal backup. The operation starts arestore similar to the one performed through the client interface.


Adapter Request Elements for 'normal-restoreOperation

Definition Required


Valid value: normal-restore.

Yes




58Restore Operations

Version 1.0.00


Definition Required

master-server-name Specifies the name of the Master Server.Default value:


No

source-client-nameSpecifies a client name to use for finding backups from which files will be restored.This name must be as it appears in the NetBackup catalog.

No

destination-client-nameSpecifies a destination client name on which the files have to be restored. If notspecified then the source client name will be considered.

No

policy-name Specifies the policy for which the backups were performed. No

policy-typeorpolicy-type-code



Valid values:



0467810111314151617181920212225303538394041

No

keyword Specifies a client name to use for finding backups from which files will be restored.This name must be as it appears in the NetBackup catalog.

No

start-date-range Specifies a start date and time for the restore window. The files are restored onlyfrom the backups that occurred at or after the specified date and time. Therequired date and time format varies according to your locale.

The default start date is 01/01/1970 00:00:00Date format: MM/dd/yyyy HH:mm:ss

No

start-date-range-epoch Specifies a start date and time in epoch for the restore window. The output listshows only images in backups or the archives that occurred at or after thespecified seconds.

No


Version 1.0.00


Definition Required

end-date-range Specifies an end date and time for the restore window. The files are restored onlyfrom the backups that occurred at or before the specified date and time. Use thesame format as for the start date and time.

The default is the current date and time.Date format: MM/dd/yyyy HH:mm:ss

No

end-date-range-epoch Specifies an end date and time for the restore window. The files are restored onlyfrom the backups that occurred at or before the specified date and time. Use thesame format as for the start date and time.


No

progress-log-file-path Specifies the name of an existing file in which the progress information will bewritten. By default the progress log will be created on the individual clients.


No

job-priority-number Specifies the job priority number. Higher number is greater priority. No

access-control-attribute

Restores the files with/without access-control attributes. By default, access-controlattributes are restored along with file and directory data. This option is availableonly on Windows platform.

Valid values: Yes | NoDefault value: Yes

No

overwrite Specifies whether to keep or overwrite the existing files when it restores files withthe same name. The default condition is to overwrite existing files.


No

rename-file Specifies the name of a file with name changes for alternate-path restores. Thepathname that you enter must be an absolute path. The file paths must startwith / (slash)The default is to restore by using the original path.

Use the following form for entries in the rename file:change backup_filepath to restore_filepath

For example: On UNIX and Linux systems: To rename the file /usr/sentry to /usr/sentry_new: change /usr/sentry to /usr/sentry_newOn Windows systems: To rename the file C:\users\sentry to C:\users\sentry_new: change /C/users/sentry to /C/users/sentry_new

No

additional-options Specifies the additional options that are not specified in this normal-restoreprocess table.

No

use-config-credentials Specifies whether to use the adapter configuration credentials for connecting tothe source client or not.


No

file-pathorfile-list-path

Specifies the name of the file with complete path to be restored.

Specifies a file (listfile) that contains a list of files to be restored. In listfile, eachfile path must be on a separate line.

The required format for the file list depends on whether the files have spaces ornewlines in the names.To restore the files that do not have spaces or new lines in the names, use thisformat:filepath

For example: C:\NetBackup\Log1.

yes


Version 1.0.00


Definition Required

To restore the files that have spaces or new lines in the names, use one of thefollowing formats:filepathlen filepath

For example: 22 C:\documents\old memos

Note: On Windows systems use upper case for the drive letter.

Sample Adapter Request for 'normal-restore Operation<request-data> <nbu-request> <operation-name>normal-restore</operation-name> <arguments> <argument> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type-code>13</policy-type-code> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <keyword>bp_test_compte</keyword> <file-path>C:\NBU Test\Files to backup</file-path> <rename-file>C:\NBU Test\rename.list</rename-file> </argument> </arguments> </nbu-request></request-data>

Adapter Response Elements for 'normal-restoreOperation

Description

restore-status Specifies the status of the restore operation.




script-path-on-peer




Sample Adapter Response for 'normal-restore Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>22854</execution-milliseconds>


Version 1.0.00


<line-count>18</line-count> <target>comte</target> <config-name>default</config-name> </metadata> <output> <restores> <restore> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type>MS-Windows</policy-type> <policy-type-code>13</policy-type-code> <keyword>bp_test_compte</keyword> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <overwrite>Yes</overwrite> <access-control-attribute>Yes</access-control-attribute> <rename-file>C:\NBU Test\rename.list</rename-file> <file-path>C:\NBU Test\Files to backup</file-path> <restore-status>initiated successfully</restore-status> </restore> </restores> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Client</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\BMC Software\AO\cdp\server\grids\GRID1\library\adapters\implementations\sentry-adapter-symantec-nbu-windows-actor_1.0.00_35\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: archive-restoreThe archive-restore operation is used to restore files from an archived backup. The operationstarts a restore similar to the one performed through the client interface.


Adapter Request Elements for 'archive-restore'Operation

Definition Required


Valid value: archive-restore.

Yes





Version 1.0.00


Definition Required

master-server-name

Specifies the name of the Master Server.Default: On UNIX and Linux systems, the first SERVER entry specified in the /usr/openv/netbackup/bp.conf file.On Windows systems, the server designated as current on the Servers tab.

No

source-client-name

Specifies a client name to use for finding backups from which to restore files. Thisname must be as it appears in the NetBackup catalog.

No

destination-client-name

Specifies a destination client name on which the files have to be restored. If notspecified then the source client name will be considered.

No





Valid values:



0467810111314151617181920212225303538394041

No

keyword Specifies a keyword phrase for NetBackup to use when it searches for backupsfrom which to restore files. The phrase must match the one that was previouslyassociated with the backup.

No



No


Specifies a start date and time in epoch for the restore window. The output listshows only images in backups or the archives that occurred at or after thespecified seconds.

No


Version 1.0.00


Definition Required



No


Specifies an end date and time for the restore window. The files are restored onlyfrom the backups that occurred at or before the specified date and time. Use thesame format as for the start date and time.


No

progress-log-file-path

Specifies the name of an existing file in which to write the progress information. Bydefault the progress log will be created on the individual clients.


No

job-priority-number

Specifies the job priority number. Higher number is greater priority. No




No

overwrite Specifies whether existing files will be kept or overwritten when files are restoredwith the same name. The default condition is to overwrite existing files.


No

rename-file Specifies the name of a file with name changes for alternate-path restores. Thepathname that you enter must be an absolute path. The file paths must start with /(slash)The default is to restore by using the original path.


For example: On UNIX and Linux systems: To rename the file /usr/sentry to /usr/sentry_new: change /usr/sentry to /usr/sentry_newOn Windows systems: To rename the file C:\users\sentry to C:\users\sentry_new: change /C/users/sentry to /C/users/sentry_new

No

additional-options Specifies the additional options that are not specified in this normal-restore processtable.

No

use-config-credentials

Specifies whether to use the adapter configuration credentials for connecting to thesource client or not.


No



Specifies a file (listfile) that contains a list of files to be restored. In listfile, each filepath must be on a separate line.

The required format for the file list depends on whether the files have spaces ornewlines in the names.

yes


Version 1.0.00


Definition Required

To restore the files that do not have spaces or new lines in the names, use thisformat:filepath





Sample Adapter Request for 'archive-restore' Operation<request-data> <nbu-request> <operation-name>archive-restore</operation-name> <arguments> <argument> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type-code>13</policy-type-code> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <keyword>bp_test_compte</keyword> <file-path>C:\NBU Test\Files to backup</file-path> <rename-file>C:\NBU Test\rename.list</rename-file> </argument> </arguments> </nbu-request>

Adapter Response Elements for 'archive-restore'Operation

Description





script-path-on-peer




Sample Adapter Response for 'archive-restore' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata>


Version 1.0.00


<responses> <response> <metadata> <status>success</status> <execution-milliseconds>22854</execution-milliseconds> <line-count>18</line-count> <target>comte</target> <config-name>default</config-name> </metadata> <output> <restores> <restore> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type>MS-Windows</policy-type> <policy-type-code>13</policy-type-code> <keyword>bp_test_compte</keyword> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <overwrite>Yes</overwrite> <access-control-attribute>Yes</access-control-attribute> <rename-file>C:\NBU Test\rename.list</rename-file> <file-path>C:\NBU Test\Files to backup</file-path> <restore-status>initiated successfully</restore-status> </restore> </restores> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Client</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\BMC Software\AO\cdp\server\grids\GRID1\library\adapters\implementations\sentry-adapter-symantec-nbu-windows-actor_1.0.00_35\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Operation: true-image-restoreThe true-image-restore operation is used to restore the files and the directories that existed in thelast true-image backup. This process is useful only if true-image backups were performed. If this option is not specified, all files and directories that meet the specified criteria are restored,even if they were deleted. The operation starts a restore similar to the one performed through theclient interface.


Adapter Request Elements for 'true-image-restore'Operation

Definition Required


Valid value: true-image-restore.

Yes


Version 1.0.00


Definition Required




master-server-name Specifies the name of the Master Server.Default:


No

source-client-nameSpecifies a client name to use for finding backups from which the files will berestored. This name must be as it appears in the NetBackup. catalog.

No


Specifies a destination client name on which files have to be restored. If not specifiedthen the source client name will be considered.

No




On UNIX and Linux systems, the default value for policy-type=Standard and forpolicy-type=0.On Windows systems, the default value for policy-type=MS-Windows and for policy-type=13.

Valid values:



0467810111314151617181920212225303538394041

No

keyword Specifies a keyword phrase for NetBackup to use when it searches for backups fromwhich files will be restored. The phrase must match the one that was previouslyassociated with the backup.

No


Version 1.0.00


Definition Required

start-date-range Specifies a start date and time for the restore window. The files are restored onlyfrom the backups that occurred at or after the specified date and time. The requireddate and time format varies according to your locale.


No


Specifies a start date and time in epoch for the restore window. The files arerestored only from the backups that occurred at or after the specified seconds.

No



No




No

progress-log-file-path

Specifies the name of an existing file in which to write the progress information. Bydefault the progress log will be created on the individual clients.

For Example:On Windows system: c:\proglog.logOn UNIX and Linux system: /home/tlc/proglog.log

No



Restores the files with/without access-control attributes. By default, access-controlattributes are restored along with file and directory data. This option is available onlyon Windows platform.


No

overwrite Specifies whether to keep or overwrite the existing files when it restores files withthe same name. The default condition is to overwrite existing files.


No

rename-file Specifies the name of a file with name changes for alternate-path restores. Thepathname that you enter must be an absolute path. The file paths must start with /(slash)The default is to restore by using the original path.


For example:On UNIX and Linux systems: To rename the file /usr/sentry to /usr/sentry_new: change /usr/sentry to /usr/sentry_newOn Windows systems: To rename the file C:\users\sentry to C:\users\sentry_new: change /C/users/sentry to /C/users/sentry_new

No

additional-options Specifies the additional options that are not specified in this normal-restore processtable.

No


Specifies whether to use the adapter configuration credentials for connecting to thesource client or not.


No


Version 1.0.00


Definition Required



Specifies a file (listfile) that contains a list of files to be restored. In listfile, each filepath must be on a separate line.






yes

Sample Adapter Request for 'true-image-restore' Operation<request-data> <nbu-request> <operation-name>true-image-restore</operation-name> <arguments> <argument> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type-code>13</policy-type-code> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <keyword>bp_test_compte</keyword> <file-path>C:\NBU Test\Files to backup</file-path> <rename-file>C:\NBU Test\rename.list</rename-file> </argument> </arguments> </nbu-request></request-data>


Version 1.0.00


Adapter Response Elements for 'true-image-restore'Operation

Description








Sample Adapter Response for 'true-image-restore' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>22854</execution-milliseconds> <line-count>18</line-count> <target>comte</target> <config-name>default</config-name> </metadata> <output> <restores> <restore> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type>MS-Windows</policy-type> <policy-type-code>13</policy-type-code> <keyword>bp_test_compte</keyword> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <overwrite>Yes</overwrite> <access-control-attribute>Yes</access-control-attribute> <rename-file>C:\NBU Test\rename.list</rename-file> <file-path>C:\NBU Test\Files to backup</file-path> <restore-status>initiated successfully</restore-status> </restore> </restores> <nbu-environment> <environment name="default"> <nbu-server-type>NetBackup Client</nbu-server-type> <platform>windows</platform> <nbu-install-path>C:\Program Files\Veritas\</nbu-install-path> <script-path-on-peer>D:\BMC Software\AO\cdp\server\grids\GRID1\library\adapters\implementations\sentry-adapter-symantec-nbu-windows-actor_1.0.00_35\</script-path-on-peer> <nbu-binary-paths> <nbu-binary-path>C:\Program Files\Veritas\netbackup</nbu-binary-path> <nbu-binary-path>C:\Program Files\Veritas\netbackup\bin</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response>


Version 1.0.00


</responses></nbu-response>

Operation: raw-partition-restoreThe raw-partition-restore operation is used to restore raw partitions (UNIX and Linux systems) ordisk images (Windows systems) instead of the complete file systems. The operation starts a restore equivalent to what is performed by using the interface on the client.


Adapter Request Elements for 'raw-partition-restore'Operation

Definition Required


Valid value: raw-partition-restore.

Yes




master-server-name Specifies the name of the master server.Default: On UNIX and Linux systems, the first SERVER entry specified in the /usr/openv/netbackup/bp.conf file.On Windows systems, the server designated as current on the Servers tab.

No

source-client-nameSpecifies a client name to use for finding backups from which files will be restored.This name must be as it appears in the NetBackup catalog.

No



No





Valid values:


StandardOracleInformix-On-BARSybaseMS-SharePointNetWare

0467810

No


Version 1.0.00


Definition Required


DataTools-SQL-BackTrack MS-WindowsOS/2 MS-SQL-ServerMS-Exchange-ServerSAPDB2NDMPFlashBackupSplit-MirrorAFSLotus-NotesVaultNBU-CatalogPureDisk-ExportEnterprise-VaultVMwareMS-Hyper-V

111314151617181920212225303538394041

keyword Specifies a keyword phrase for NetBackup to use when it searches for backupsfrom which files will be restored. The phrase must match the one that waspreviously associated with the backup.

No



No



No



No




No



No





No


Version 1.0.00


Definition Required

overwrite Specifies whether existing files will be kept or overwritten when files are restoredwith the same name. The default condition is to overwrite existing files.


No

rename-file Specifies the name of a file with name changes for alternate-path restores. Thepathname that you enter must be an absolute path. The file paths must startwith / (slash)The default is to restore by using the original path.


For example: On UNIX and Linux systems: To rename the file /usr/sentry to /usr/sentry_new:change /usr/sentry to /usr/sentry_newOn Windows systems: To rename the file C:\users\sentry to C:\users\sentry_new:change /C/users/sentry to /C/users/sentry_new

No


No

use-config-credentials Specifies whether to use the adapter configuration credentials for connecting tothe source client or not.


No




The required format for the file list depends on whether the files have spaces ornewlines in the names.

To restore the files that do not have spaces or new lines in the names, use thisformat:filepath





yes

Sample Adapter Request for 'raw-partition-restore' Operation<request-data> <nbu-request> <operation-name>true-image-restore</operation-name> <arguments> <argument> <source-client-name>comte</source-client-name> <policy-name>bao-test-policy</policy-name> <policy-type-code>13</policy-type-code> <master-server-name>madrid.internal.sentrysoftware.net</master-server-name> <progress-log-file-path>C:\NBU Test\Log\client_restore.log</progress-log-file-path> <keyword>bp_test_compte</keyword> <file-path>C:\NBU Test\Files to backup</file-path> <rename-file>C:\NBU Test\rename.list</rename-file> </argument> </arguments>


Version 1.0.00


</nbu-request></request-data>

Adapter Response Elements for 'raw-partition-restore'Operation

Description








Sample Adapter Response for 'raw-partition-restore' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>20125</execution-milliseconds> <line-count>4</line-count> <target>wellington</target> <config-name>default</config-name> </metadata> <output> <restores> <restore> <source-client-name>wellington</source-client-name> <progress-log-file-path>/tmp/restore.log</progress-log-file-path> <file-path>/mnt</file-path> <restore-status>initiated successfully</restore-status> </restore> </restores> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type> <platform>Linux</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <script-path-on-peer /> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>


Version 1.0.00


Operation: snapshot-rollback-restoreThe snapshot-rollback-restore operation uses snapshot backups to restore the files. The rollback operation always occurs from copy 1. If copy 1 is expired, the rollback fails. Theoperation starts a restore similar to the one performed through the client interface.


Adapter Request Elements for 'snapshot-rollback-restore' Operation

Definition Required


Valid value: snapshot-rollback-restore.

Yes




master-server-name Specifies the name of the master server.Default:


No

source-client-nameSpecifies a client name to use for finding backups from which files will berestored. This name must be as it appears in the NetBackup catalog.

No



No





Valid values:


StandardOracleInformix-On-BARSybaseMS-SharePointNetWareDataTools-SQL-BackTrack MS-Windows

04678101113

No


Version 1.0.00


Definition Required


OS/2 MS-SQL-ServerMS-Exchange-ServerSAPDB2NDMPFlashBackupSplit-MirrorAFSLotus-NotesVaultNBU-CatalogPureDisk-ExportEnterprise-VaultVMwareMS-Hyper-V

14151617181920212225303538394041

keyword Specifies a keyword phrase for NetBackup to use when it searches for backupsfrom which files will be restored. The phrase must match the one that waspreviously associated with the backup.

No



No



No



No




No



No



Restores the files with/without access-control attributes. By default, access-control attributes are restored along with file and directory data. This option isavailable only on Windows platform.


No

skip-verification Specifies whether to skip the verification and force the rollback.

Valid values: Yes | No

No


Version 1.0.00


Definition Required

Default value: No


No


Specifies whether to use the adapter configuration credentials for connecting tothe source client or not.


No









yes

Sample Adapter Request for 'snapshot-rollback-restore' Operation<request-data> <nbu-request> <operation-name>snapshot-rollback-restore</operation-name> <arguments> <argument> <file-path>/mnt</file-path> <source-client-name>wellington</source-client-name> <progress-log-file-path>/tmp/restore.log</progress-log-file-path> <use-config-credentials>yes</use-config-credentials> <main-operation-name>raw-partition-restore</main-operation-name> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type> <platform>Linux</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <script-path-on-peer /> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </argument> </arguments> </nbu-request></request-data>


Version 1.0.00


Adapter Response Elements for 'snapshot-rollback-restore' Operation

Description





script-path-on-peer




Sample Adapter Response for 'snapshot-rollback-restore' Operation<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>25725</execution-milliseconds> <line-count>4</line-count> <target>wellington</target> <config-name>default</config-name> </metadata> <output> <restores> <restore> <source-client-name>wellington</source-client-name> <progress-log-file-path>/tmp/restore.log</progress-log-file-path> <file-path>/mnt</file-path> <restore-status>initiated successfully</restore-status> </restore> </restores> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type> <platform>Linux</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <script-path-on-peer /> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

78Use Cases

Version 1.0.00


Use Cases

The workflow described in this section is an example of how to combine the low-level operations totest client backup restore.

You can use this example to build your own client backup workflow.

Operation: test-client-backup-restore

Adapter Request for 'test-client-backup-restore'Operation

Definition Required

client-name Specifies the client name. Yes

policy-name Specifies the policy name to which a client will be added. Yes

username

Specifies a user account with administrative privileges to read and executeSymantec NetBackup commands. If the client name is different from theadapter configuration target name then this value must be specified.

For example:On Windows system: Domain\UsernameOn UNIX and Linux system: Username

No


use-config-credentials Specifies whether to use the adapter configuration credentials for connectingto the client or not.


No

ssh-port Specifies the client’s SSH port number.Default value: 22

No

sudo-privilege Specifies whether the command on the client must be executed with SUDOprivilege or not.

Default: No

No

private-key-file Specifies the path and file name of the local ssh key file. The path and filemust exist on the peer servicing the adapter request. This element is used ifthe password element is not provided.If password and private key file elements are both provided, then private KeyFile approach is used and the password element will be ignored.

No

pass-phrase Pass phrase for private key No

installation-path The default installation path of the Symantec Netbackup Client.For example: /opt/openv or /usr/openv or /opt/VRTSnetbp

No


Specifies a path to the file that must be backed up. A file path can be a filename or a directory name. If the named files include a directory, it backs upall files and subdirectories of that directory i.e. it starts at the directory itself.

For example:On UNIX and Linux system: /home, /tmp/backup.logOn Windows system: C:\Programs, c:\backup.log

Yes

79Use Cases

Version 1.0.00


Definition Required

Specifies a path to the file (list file) that contains a list of files to be backedup. This file must exist on the adapter configured target system.

For example:On UNIX and Linux system: /tmp/backupFileListOn Windows system: C:\backupFileList

master-server-name Specifies the name(s) of the Master Server.Default:


No



On UNIX and Linux systems, the default value for policy-type=Standard andfor policy-type=0.On Windows systems, the default value for policy-type=MS-Windows and forpolicy-type=13.

Valid values:



0467810111314151617181920212225303538394041

No

schedule-name Specifies the schedule name to use for the backup. If not specified,NetBackup uses the first user backup schedule it finds for the client in thepolicy currently in use.

No

keyword Specifies a keyword phrase associated with the image created by this backupoperation. This may be helpful while restoring an image by just specifyingthe keyword phrase. The keyword phrase is a textual description of the backup that is a maximumof 128 characters in length.The default keyword phrase is the null (empty) string.

No

80Use Cases

Version 1.0.00


Definition Required

progress-log-file-path Specifies the name of a file in which the backup progress information iswritten. NetBackup creates the file if it does not exist. By default the progresslog will be created on the individual clients.


No

additional-options Specifies the additional options that are not specified in this client-backupprocess table.

No

archive Specifies the files to be archived. The files will be deleted after archivedsuccessfully.


No

source-client-name Specifies a client name to use for finding backups from which to restore files.This name must be as it appears in the NetBackup catalog.

No

destination-client-name Specifies a destination client name on which the files have to be restored. Ifnot specified then the source client name will be considered.

No

start-date-range Specifies a start date and time for the restore window. The files are restoredonly from the backups that occurred at or after the specified date and time.The required date and time format varies according to your locale.


No

start-date-range-epoch Specifies a start date and time in epoch for the restore window. The outputlist shows only images in backups or the archives that occurred at or afterthe specified seconds.

No

end-date-range Specifies an end date and time for the restore window. The files are restoredonly from the backups that occurred at or before the specified date and time.Use the same format as for the start date and time.


No

end-date-range-epoch Specifies an end date and time in epoch for the restore window. The files arerestored only from the backups that occurred at or before the specifiedseconds.

No


access-control-attribute Restores the files with/without access-control attributes. By default, access-control attributes are restored along with file and directory data. This optionis available only on Windows platform.


No

overwrite Specifies whether existing files will be kept or overwritten when files arerestored with the same name. The default condition is to overwrite existingfiles.


No

rename-file Specifies the name of a file with name changes for alternate-path restores.The pathname that you enter must be an absolute path. The file paths muststart with / (slash)The default is to restore by using the original path.


No

81Use Cases

Version 1.0.00


Definition Required

For example:On UNIX and Linux systems: To rename the file /usr/sentry to /usr/sentry_new:change /usr/sentry to /usr/sentry_new

On Windows systems: To rename the file C:\users\sentry to C:\users\sentry_new:change /C/users/sentry to /C/users/sentry_new

Sample Adapter Request for 'test-client-backup-restore'Operation<request-data> <nbu-request> <operation-name>get-environment</operation-name> <arguments> <argument> <client-name hardware="RedHat2.6" os="Linux" priority="0">beijing</client-name> <policy-name>policy_1</policy-name> <file-path>/etc/rc.d/init.d/</file-path> <progress-log-file-path>/tmp/bp_test.log</progress-log-file-path> <rename-file>/tmp/rename.txt</rename-file> <use-config-credentials>yes</use-config-credentials> <main-operation-name>add-client-to-policy</main-operation-name> </argument> </arguments> </nbu-request></request-data>

Sample Adapter Response for 'test-client-backup-restore' Operation

Response 1: add-client-to-policy<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>3495</execution-milliseconds> <line-count>13</line-count> <target>dhaka</target> <config-name>default</config-name> </metadata> <output> <clients> <client> <policy-name>policy_1</policy-name> <client-name hardware="RedHat2.6" os="Linux" priority="0">beijing</client-name> <add-status>success</add-status> </client> </clients> <nbu-environment> <environment name="default"> <nbu-server-type>Master</nbu-server-type> <platform>unix</platform>

82Use Cases

Version 1.0.00


<nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Response 2: client-backup<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response> <metadata> <status>success</status> <execution-milliseconds>188665</execution-milliseconds> <line-count>16</line-count> <target>beijing</target> <config-name>default</config-name> </metadata> <output> <backups> <backup> <client-name>beijing</client-name> <policy-name>policy_1</policy-name> <progress-log-file-path>/tmp/bp_test.log</progress-log-file-path> <file-path>/etc/rc.d/init.d/</file-path> <archive>No</archive> <backup-status>initiated successfully</backup-status> </backup> </backups> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type> <platform>unix</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Response 3: normal-restore<nbu-response> <metadata> <status>success</status> <response-count>1</response-count> </metadata> <responses> <response>

83Use Cases

Version 1.0.00


<metadata> <status>success</status> <execution-milliseconds>5990</execution-milliseconds> <line-count>17</line-count> <target>beijing</target> <config-name>default</config-name> </metadata> <output> <restores> <restore> <source-client-name>beijing</source-client-name> <policy-name>policy_1</policy-name> <progress-log-file-path>/tmp/bp_test.log</progress-log-file-path> <overwrite>Yes</overwrite> <rename-file>/tmp/rename.txt</rename-file> <file-path>/etc/rc.d/init.d/</file-path> <restore-status>initiated successfully</restore-status> </restore> </restores> <nbu-environment> <environment name="default"> <nbu-server-type>Media Host</nbu-server-type> <platform>unix</platform> <nbu-install-path>/usr/openv/</nbu-install-path> <nbu-binary-paths> <nbu-binary-path>/usr/openv/netbackup</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/admincmd</nbu-binary-path> <nbu-binary-path>/usr/openv/netbackup/bin/goodies</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin</nbu-binary-path> <nbu-binary-path>/usr/openv/volmgr/bin/goodies</nbu-binary-path> </nbu-binary-paths> <nbu-library-path>/usr/openv/lib</nbu-library-path> </environment> </nbu-environment> </output> </response> </responses></nbu-response>

Index 84

Version 1.0.00


Index

- A -Adapter

Configuration 14

Install 11

Upload 11Adapter Module

Life Cycle 9Adapter Operation

activate-policy 22

add-client-to-policy 22

archive-restore 22

client-backup 22

deactivate-policy 22

delete-client-from-policy 22

get-client 22

get-client-hardware-os 22

get-environment 22

get-job-info 22

get-storage-system 22

manual-backup 22

nbu-execute 22

normal-restore 22

raw-partition-restore 22

remove-volume-from-volume-group 22

snapshot-rollback-restore 22

true-image-restore 22Adapter Request

Writing 24

- B -Backup Operations

client-backup 50, 53

manual-backup 50BMC

BMC Atrium Orchestrator Grid Manager 11, 14

BMC Atrium Orchestrator Repository 11

Designer View 11

Development Studio 11

- C -Client Operations

add-client-to-policy 37, 41

client-hardware-os 39

delete-client-from-policy 37, 43

get-client 37

get-client-hardware-os 37Command Operation

nbu-execute 28Configuration

Actor Adapter 14

Grid Manager 14

IBM Adapter 14

Multiple 17

- D -Debug 17

Directory

SetupValidation 20

Utilities 20

Version 20

- E -Element

Config 14

password 14

port 14

protocol 14

target 14

timeout-secs 14

user-name 14Environment Operations

get-environment 24

- I -IBM

IBM Storage Adapter Module 20Installation

Adapter 11

Index 85

Version 1.0.00


- J -Job Operations

get-job-info 45

- L -Life Cycle

Adapter Module 9

- O -Operation

test-client-backup-restore 78

- P -Package

aroar 11

roar 11Policy Operations

activate-policy 30, 33

deactivate-policy 30, 35

get-policy 30, 31Process name

Activate Policy 22

Add Client to Policy 22

Archive Restore 22

Client Backup 22

Deactivate Policy 22

Delete Client from Policy 22

Get Client 22

Get Client Hardware OS 22

Get Environment 22

Get Job Info 22

Get Policy 22

Manual Backup 22

Nbu Execute 22

Normal Restore 22

Raw Partition Restore 22

Snapschot Rollback Restore 22

True Image Restore 22Processes

General 20

XML 20

- R -Request Elements

access-control-attribute 57, 61, 65, 70, 74

additional-options 50, 53, 57, 61, 65, 70,74

archive 53

argument 28

arguments 28

client-name 37, 43, 45, 50, 53

destination-client-name 57, 61, 65, 70, 74

disk-staging-storage-unit-name 50

end-date-range 45, 57, 61, 65, 70, 74

end-date-range-epoch 45, 57, 61, 65, 70,74

file-list-path 53, 57, 61, 65, 70, 74

file-path 53, 57, 61, 65, 70, 74

hardware 39

installation-path 24, 53

job-id 45

job-priority-number 57, 61, 65, 70, 74

job-type or job-type-code 45

keyword 50, 53, 57, 61, 65, 70, 74

master-server-name 45, 50, 53, 57, 61,65, 70, 74

operation-name 28

os 39

overwrite 57, 61, 65, 70, 74

pass-phrase 24, 53

password 24, 53

policy-name 31, 33, 35, 43, 45, 50, 53,57, 61, 65, 70, 74

policy-type 50, 53, 57, 61, 65, 70, 74

policy-type-code 50, 53, 57, 61, 65, 70,74

private-key-file 24, 53

progress-log-file-path 50, 53, 57, 61, 65,70, 74

rename-file 57, 61, 65, 70, 74

schedule-name 50, 53

source-client-name 57, 61, 65, 70, 74

ssh-port 24, 53

start-date-range 45, 57, 61, 65, 70, 74

start-date-range-epoch 45, 57, 61, 65,70, 74

storage-system-name 28

sudo-privilege 24, 53

target 24, 28

Index 86

Version 1.0.00


Request Elements

timeout-secs 28

use-config-credentials 53, 57, 61, 65, 70,74

username 24, 53Requests

Actor Adapter 22

Typical 22Response Elements

add-status 43

available-capacity-bytes 28

available-capacity-gigabytes 28

backup-status 50, 53

chassis-type 28

client-name 31, 37, 43, 45

effective-date 31

effective-date-epoch 31

elapsed-time-seconds 45

end-date-range 45

end-date-range-epoch 45

hardware 37, 39

is-active 31

job-complete-percent 45

job-id 45

job-status 45

job-type 45

job-type-code 45

keyword 31

master-server-name 45

model 28

operational-status 28

operational-status-description 28

os 37, 39

policy status 35

policy-name 31, 33, 35, 37, 43, 45

policy-priority 31

policy-status 33

policy-type 31

policy-type-code 31

priority 37

residence 31

restore-status 57, 61, 65, 70, 74

schedule-daily-window 31

schedule-name 31

schedule-type 31, 45

schedule-type-code 31, 45

size-bytes 28

size-gigabytes 28

start-date-range 45

start-date-range-epoch 45

storage-system-name 28

subscribed-capacity-bytes 28

subscribed-capacity-gigabytes 28

volume-pool 31Responses

Actor Adapter 22

Typical 22Restore Operations

archive-restore 57, 61

normal-restore 57

raw-partition-restore 57, 70

snapshot-rollback-restore 57, 74

true-image-restore 57, 65

- S -Samples

Actor Adapter Configuration 14

Adapter Request 24, 28, 31, 33, 35, 37,39, 41, 43, 45, 50, 53, 57, 61, 65, 70, 74, 78

Adapter Response 24, 28, 31, 33, 35, 37,39, 41, 43, 45, 50, 53, 57, 61, 65, 70, 74, 78

SetupValidation

Directory 20Support 5

Multiple Configuration 17Supported

Versions 10

- U -UI Label

Password 14

Port 14

Protocol 14

Target 14

Timeout Secs 14

User Name 14Use Cases 78

Utilities

Directory 20

- V -Version

Directory 20Versions

Index 87

Version 1.0.00


Versions

Supported 10View

XML 14

- W -Writing

Adapter Request 24

- X -XML

View 14

About BMC® SoftwareBMC Software, Inc. NYSE:BMC, is a leading provider of enterprise management solutionsthat empower companies to manage their IT infrastructure from a business perspective.Delivering Business Service Management, BMC Software solutions span enterprisesystems, applications, databases, and service management. Founded in 1980, BMCSoftware has offices worldwide and fiscal 2004 revenues of more than $1.4 billion. For

more information about BMC Software, visit www.bmc.com.

About Sentry Software™Sentry Software, a strategic Technology Alliance Partner of BMC Software, provides keymonitoring solutions specifically designed to expand the capabilities of BMCPerformance Manager, thus enabling up to 100% coverage of any infrastructure. SentrySoftware specializes in single solutions for multi-platform monitoring of hardware,custom applications or any IT component, and blackout windows. Sentry Softwareproducts are deployed in 45 countries across the globe and lead the list of BMCSoftware’s third-party product sales. For more information about Sentry Software,

please visit www.sentrysoftware.net.

Date post:	05-Jun-2018
Category:	Documents
Upload:	vodang
View:	225 times
Download:	0 times

BMC Atrium Orchestrator Application Adapter for Symantec ...€¦ · Table of Contents 2 Version...

Documents