Sybase ASE plug-in

01/19/2021 Contributors

PDFs

The Sybase ASE plug-in uses the isql command to interact with the Sybase database.

For latest information about support or to view compatibility matrices, see the Interoperability Matrix.

The following table lists the Sybase plug-in parameters, provides their settings, and describes them:

Parameter Setting Description

Parameter	Setting	Description
SYBASE_USER	user_name	Specifies the operating system user who can run the isql command. This parameter is required for UNIX. This parameter is required if the user running the Snap Creator Agentstart and stop commands (usually the root user) and the user running the isql command are different.
SYBASE_SERVER	data_server_name	Specifies the Sybase data server name (-S option on isql command).For example: `p_test`
SYBASE_DATABASES	db_name:user_name/password	Lists the databases within the instance to back up. The master database is added; for example: `DBAtest2:sa/53616c7404351e`.If a database named +ALL is used, then database automatic discovery is used, and the sybsyntax, sybsystemdb, sybsystemprocs, and tempdb databases are excluded. For example: `+ALL:sa/53616c71a6351e` Encrypted passwords are supported if the NTAP_PWD_PROTECTION parameter is set.
SYBASE_DATABASES_EXCLUDE	db_name	Allows databases to be excluded if the +ALL construct is used. You can specify multiple databases by using a semicolon-separated list.For example, `pubs2;test_db1`
SYBASE_TRAN_DUMP	db_name:directory_path	Enables you to perform a Sybase transaction dump after creating a Snapshot copy.For example: `pubs2:/sybasedumps/pubs2` You must specify each database that requires a transaction dump.
SYBASE_TRAN_DUMP_FORMAT	%S_%D_%T.cmn	Enables you to specify the dump naming convention. The following keys can be specified: %S = instance name from SYBASE_SERVER %D = database from SYBASE_DATABASES %T = unique timestamp Here is an example: `%S_%D_%T.log`
SYBASE_TRAN_DUMP_COMPRESS	(Y	N )
Enables or disables native Sybase transaction dump compression.	SYBASE_ISQL_CMD	Example: /opt/sybase/OCS-15__0/bin/isql
Defines the path to the isql command.	SYBASE	Example: /sybase
Specifies the location of the Sybase installation.	SYBASE_LOGDIR	Example: /usr/local/ntap/scServer/logs
Defines the directory where Snap Creator logs are placed.	SYBASE_MANIFEST	Example: `DBAtest2:/t_inf_nzl_devs/`
Specifies the databases for which the manifest file should be created, along with the location where the manifest file should be placed.	SYBASE_MANIFEST_FORMAT	%S__%D_%T.manifest Example: `%S_%D_%T.manifest`
Enables you to specify the manifest file naming convention. The following keys can be specified: %S = Instance name from SYBASE_SERVER %D = database from SYBASE_DATABASES %T = unique timestamp, which is the same as that used for Snapshot copy naming	SYBASE_MANIFEST_DELETE	(Y
N )	Allows the manifest to be deleted after the Snapshot copy has been created. The manifest file should be captured in the Snapshot copy so that it is always available with the backup.	SYBASE_EXCLUDE_TEMPDB
(Y	N )	Enables automatic exclusion of user-created temporary databases.

SYBASE_USER

user_name

Specifies the operating system user who can run the isql command. This parameter is required for UNIX. This parameter is required if the user running the Snap Creator Agentstart and stop commands (usually the root user) and the user running the isql command are different.

SYBASE_SERVER

data_server_name

Specifies the Sybase data server name (-S option on isql command).For example: p_test

SYBASE_DATABASES

db_name:user_name/password

Lists the databases within the instance to back up. The master database is added; for example: DBAtest2:sa/53616c7404351e.If a database named +ALL is used, then database automatic discovery is used, and the sybsyntax, sybsystemdb, sybsystemprocs, and tempdb databases are excluded.

For example: +ALL:sa/53616c71a6351e

Encrypted passwords are supported if the NTAP_PWD_PROTECTION parameter is set.

SYBASE_DATABASES_EXCLUDE

db_name

Allows databases to be excluded if the +ALL construct is used. You can specify multiple databases by using a semicolon-separated list.For example, pubs2;test_db1

SYBASE_TRAN_DUMP

db_name:directory_path

Enables you to perform a Sybase transaction dump after creating a Snapshot copy.For example: pubs2:/sybasedumps/pubs2

You must specify each database that requires a transaction dump.

SYBASE_TRAN_DUMP_FORMAT

%S_%D_%T.cmn

Enables you to specify the dump naming convention. The following keys can be specified:

%S = instance name from SYBASE_SERVER
%D = database from SYBASE_DATABASES
%T = unique timestamp

Here is an example: %S_%D_%T.log

SYBASE_TRAN_DUMP_COMPRESS

N )

Enables or disables native Sybase transaction dump compression.

SYBASE_ISQL_CMD

Example: /opt/sybase/OCS-15__0/bin/isql

Defines the path to the isql command.

SYBASE

Example: /sybase

Specifies the location of the Sybase installation.

SYBASE_LOGDIR

Example: /usr/local/ntap/scServer/logs

Defines the directory where Snap Creator logs are placed.

SYBASE_MANIFEST

Example: DBAtest2:/t_inf_nzl_devs/

Specifies the databases for which the manifest file should be created, along with the location where the manifest file should be placed.

SYBASE_MANIFEST_FORMAT

%S__%D_%T.manifest Example: %S_%D_%T.manifest

Enables you to specify the manifest file naming convention. The following keys can be specified:

%S = Instance name from SYBASE_SERVER
%D = database from SYBASE_DATABASES
%T = unique timestamp, which is the same as that used for Snapshot copy naming

SYBASE_MANIFEST_DELETE

N )

Allows the manifest to be deleted after the Snapshot copy has been created. The manifest file should be captured in the Snapshot copy so that it is always available with the backup.

SYBASE_EXCLUDE_TEMPDB

N )

Enables automatic exclusion of user-created temporary databases.

Related information

Interoperability Matrix Tool: mysupport.netapp.com/matrix

Sybase ASE plug-in

Creating your file...