Cmdlets for DB2

Build 23.0.8770

Parameters (Connect-DB2 Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Authentication


PropertyDescription
AuthSchemeThe authentication mechanism that the provider will use to authenticate with DB2.
ServerThe name of the DB2 server.
PortThe port used to connect to the server hosting the DB2 database.
DatabaseThe name of the DB2 database.
UserA database user.
PasswordThe user's password.
UseSSLThis field sets whether SSL is enabled.
AlternateServersThis property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

SSH


PropertyDescription
SSHAuthModeThe authentication method used when establishing an SSH Tunnel to the service.
SSHClientCertA certificate to be used for authenticating the SSHUser.
SSHClientCertPasswordThe password of the SSHClientCert key if it has one.
SSHClientCertSubjectThe subject of the SSH client certificate.
SSHClientCertTypeThe type of SSHClientCert private key.
SSHServerThe SSH server.
SSHPortThe SSH port.
SSHUserThe SSH user.
SSHPasswordThe SSH password.
SSHServerFingerprintThe SSH server fingerprint.
UseSSHWhether to tunnel the DB2 connection over SSH. Use SSH.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
AllowPreparedStatementPrepare a query statement before its execution.
CharBitDataAsStringA Boolean value used to indicate whether parameters, result data, and schema information for iDB2CharBitData and iDB2VarCharBitData objects are treated as String values or as Byte array values.
CharBitDataCcsidAn Int32 value used to indicate which CCSID is used to translate iDB2CharBitData and iDB2VarCharBitData types when the CharBitDataAsString property is set to true. This property is ignored when CharBitDataAsString is set to false.
TruncateStringThis property specifies whether to truncate characters when INSERT or UPDATE is executed with a string that exceeds the column size.
SchemaThe schema which will be used by default.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
QueryPassthroughThis option passes the query to the DB2 server as is.
ReadonlyYou can use this property to enforce read-only access to DB2 from the provider.
RTKThe runtime key used for licensing.
SwitchModeThis property allows you to specify a switching mode to select a server from AlternateServers as the active server.
SwitchStrategyThis property allows you to specify a switching strategy to select a server from AlternateServers as the active server.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8770