Adding an application server for databases

Add an application server for databases.

_images/reference_db2_create01.png

The same action can be taken in the IBM Spectrum Protect Plus web user interface: In the navigation pane, click Manage Protection > Databases and click Manage application servers.

_images/reference_db2_create02.png

In the Manage application servers section, click Add application server.

_images/reference_db2_create03.png

Enter the required fields. Click Get databases for Db2 and Oracle; or click Get instances button for MongoDB. Ensure all databases in this application server are shown in the list below. Optionally, you can specify the maximum concurrent databases (default: 10).

Method and URI

To add an application server, use a POST method with a URI:

POST    https://{hostname|IPv4}/ngp/appserver

Parameters

None.

Data

Key

Value (example)

Type

Description

name

String

Arbitrary, friendly name of the application server

hostAddress

10.7.7.1

String |b|

IPv4 address of the application server

username

sarah-db2

String |b|

Username of the application server

password

:W}/{sgN6v9k7X+H

String |b|

Password of the application server

osType

linux

System string |b|

Type of operating system

applicationType

db2

System string |b|

Type of application server

addToCatJob

true

System Boolean |s|

Indication of whether an inventory job starts after registrationi

script

false

System Boolean |s|

***

application

true

System Boolean |s|

***

useForAllInstances

false

System Boolean |s|

***

opProperties

{…, …}

Array |b|

***

Requirement: You must have at least one default site which is usually Primary. If you set another site as a default site, the current one is unset.

osType: Use one of the followings:

Value

Description

linux

Linux on Db2, MongoDB, or Oracle

windows

Microsoft Windows for Exchange Server or SQL Server

aix

IBM AIX for Db2, or Oracle

applicationType: Use one of the followings:

Value

Description

db2

Db2

exch

Exchange Server

mongo

MongoDB

oracle

Oracle

sql

SQL Server

opProperties: Use one of the followings:

Key

Value (example)

Type

Description

maxConcurrency

10 (default)

Integer |b|

Maximum number of databases to back up concurrently on the server

Tip

Server performance is impacted when many databases are backed up concurrently, as each databaseutilizes multiple threads and consumes bandwidth when copying data. Use this option to control theimpact on server resources and minimize the impact on production operations.

Example

As you can see in the IBM Spectrum Protect Plus interface in your web browser, you can register an application server for databases with same way regardless of what application it hosts.

For example, assume that you want to register the following application server that hosts IBM Db2 databases with IBM Spectrum Protect Plus.

  • Host Address: 10.7.7.1

  • Username: sarah-db2

  • Password: :W}/{sgN6v9k7X+H

  • Operating system of the application server: Linux

  • Application type: IBM Db2

  • Run an inventory job for application server instances after the registration: No

  • Options:

    • Maximum concurrent databases: 10

The following Python snippet requests a list of all sites and their information:

_data = f'''{{
    "name":               "10.7.7.1",
    "hostAddress":        "10.7.7.1",
    "username":           "sarah-db2",
    "password":           ":W}}/{{sgN6v9k7X+H",
    "osType":             "linux",
    "applicationType":    "db2",
    "addToCatJob":        false,
    "script":             false,
    "application":        true,
    "useForAllInstances": false,
    "opProperties":       {{"maxConcurrency":10}}
}}'''

requests.post('https://' + spp_ipv4 + '/ngp/appserver',
    headers={...}, data=_data, verify=...)

The request prompts a response that is structured as shown, with the HTTP status of 201 (Created). Review the response to ensure that the new application server, , was created.