db2 database

Overview

This resource allows you to manage an DB2 Database. Here is an example on how you can do this:

db2_database {'db2inst1/MYDB':
  ensure => 'present',
  rec_his_retentn      => 90,
  section_actuals      => 'NONE',
  self_tuning_mem      => 'ON',
  seqdetect            => 'YES',
}

This statement will ensure a database MYDB on instance db2inst1.

Attributes

Attribute Name	Short Description
act_sortmem_limit	Detailed documentation not (yet) available.
allow_restart	Allow puppet to do a restart of the database.
alt_collate	Alternate collating sequence.
app_ctl_heap_sz	Detailed documentation not (yet) available.
appgroup_mem_sz	Detailed documentation not (yet) available.
appl_memory	Application Memory Size (4KB).
applheapsz	Default application heap (4KB).
archretrydelay	Log archive retry Delay (secs).
authn_cache_duration	Lifetime of cached credentials.
authn_cache_users	Max number of users in the cache.
auto_cg_stats	Automatic column group statistic.
auto_db_backup	Automatic database backup.
auto_del_rec_obj	Auto deletion of recovery objects.
auto_maint	Automatic maintenance.
auto_reorg	Automatic reorganization.
auto_reval	Auto-Revalidation.
auto_runstats	Automatic runstats.
auto_sampling	Automatic sampling.
auto_stats_views	Statistical views.
auto_stmt_stats	Real-time statistics.
auto_tbl_maint	Automatic table maintenance.
autorestart	Auto restart enabled.
avg_appls	Average number of active applications.
backup_pending	Detailed documentation not (yet) available.
blk_log_dsk_ful	Block log on disk full.
blocknonlogged	Block non logged operations.
catalogcache_sz	Catalog cache size (4KB).
cf_catchup_trgt	Detailed documentation not (yet) available.
cf_db_mem_sz	Detailed documentation not (yet) available.
cf_gbp_sz	Detailed documentation not (yet) available.
cf_lock_sz	Detailed documentation not (yet) available.
cf_sca_sz	Detailed documentation not (yet) available.
chngpgs_thresh	Changed pages threshold.
codepage	Detailed documentation not (yet) available.
codeset	Detailed documentation not (yet) available.
collate_info	Detailed documentation not (yet) available.
connect_proc	Connect procedure.
ctrl_file_recov_path	Detailed documentation not (yet) available.
cur_commit	Currently Committe.
database_consistent	Detailed documentation not (yet) available.
database_level	Detailed documentation not (yet) available.
database_memory	Size of database shared memory (4KB).
database_name	The name of the database.
date_compat	Detailed documentation not (yet) available.
db_mem_thresh	Database memory threshold.
dbheap	Database heap (4KB).
ddl_compression_def	Enable row compression by default.
ddl_constraint_def	Enforce Constraint.
dec_arithmetic	DECIMAL arithmetic mode.
dec_to_char_fmt	CHAR output with DECIMAL input.
decflt_rounding	Decimal floating point rounding mode.
dft_degree	Degree of parallelis.
dft_extent_sz	Default tablespace extentsize (pages).
dft_loadrec_ses	Default number of loadrec sessions.
dft_mttb_types	Default maintained table types for op.
dft_prefetch_sz	Default prefetch size (pages).
dft_queryopt	Default query optimization class.
dft_refresh_age	Default refresh age.
dft_schemas_dcc	Default data capture on new Schemas.
dft_sqlmathwarn	Continue upon arithmetic exceptions.
dft_table_org	Default table organization.
disable_corrective_change	Disable the modification of a resource when Puppet decides it is a corrective change.
disable_corrective_ensure	Disable the creation or removal of a resource when Puppet decides is a corrective change.
discover_db	Discovery support for this database.
dlchktime	Interval for checking deadlock (ms).
enable_xmlchar	Enable XML Character operations.
encrlib	Encryption Library for Backup.
encropts	Encryption Options for Backup.
ensure	The basic property that the resource should be in.
extbl_location	Allowed paths for external table.
extbl_strict_io	Strict I/O for EXTBL_LOCATION.
extended_row_sz	Extended row size support.
failarchpath	Failover log archive path.
groupheap_ratio	Detailed documentation not (yet) available.
hadr_db_role	Detailed documentation not (yet) available.
hadr_local_host	HADR local host name.
hadr_local_svc	HADR local service name.
hadr_peer_window	HADR peer window duration (seconds).
hadr_remote_host	HADR remote host name.
hadr_remote_inst	HADR instance name of remote server.
hadr_remote_svc	HADR remote service name.
hadr_replay_delay	HADR log replay delay (seconds).
hadr_role	The HADR role of the database.
hadr_spool_limit	HADR spool log data limit (4KB).
hadr_ssl_host_val	Detailed documentation not (yet) available.
hadr_ssl_label	HADR SSL certificate label.
hadr_syncmode	HADR log write synchronization mode.
hadr_target_list	HADR target list.
hadr_timeout	HADR timeout value.
indexrec	Index re-creation time and redo index build.
instance_name	The name of the instance.
large_aggregation	Detailed documentation not (yet) available.
locklist	Max storage for lock list (4KB).
locktimeout	Lock timeout (sec).
log_appl_info	Log Application Information.
log_ddl_stmts	Log DDL Statements.
log_disk_cap	Active log space disk capacity (MB).
log_retain_status	Detailed documentation not (yet) available.
logarchcompr1	Archive compression for logarchmeth1.
logarchcompr2	Archive compression for logarchmeth2.
logarchmeth1	First log archive method.
logarchmeth2	Second log archive method.
logarchopt1	Options for logarchmeth1.
logarchopt2	Options for logarchmeth2.
logbufsz	Log buffer size (4KB).
logfilsiz	Log file size (4KB).
loghead	Detailed documentation not (yet) available.
logindexbuild	Log pages during index build.
logpath	Detailed documentation not (yet) available.
logprimary	Number of primary log files.
logsecond	Number of secondary log files.
max_log	Percent max primary log space by transaction.
maxappls	Max number of active applications.
maxfilop	Max DB files open per database.
maxlocks	Percentage of lock lists per application.
min_dec_div_3	Detailed documentation not (yet) available.
mincommit	Detailed documentation not (yet) available.
mirrorlogpath	Mirror log path.
mon_act_metrics	Activity metrics.
mon_deadlock	Deadlock events.
mon_lck_msg_lvl	Lock event notification level.
mon_locktimeout	Lock timeout events.
mon_lockwait	Lock wait events.
mon_lw_thresh	Lock wait event threshold.
mon_obj_metrics	Object metrics.
mon_pkglist_sz	Number of package list entries.
mon_req_metrics	Request metrics.
mon_rtn_data	Routine data.
mon_rtn_execlist	Routine executable list.
mon_uow_data	Unit of work events.
mon_uow_execlist	UOW events with executable list.
mon_uow_pkglist	UOW events with package list.
multipage_alloc	Detailed documentation not (yet) available.
name	The name of the database.
nchar_mapping	National character string mapping.
newlogpath	Changed path to log files.
num_db_backups	Number of database backups to retain.
num_freqvalues	Number of frequent values retained.
num_iocleaners	Number of asynchronous page cleaners.
num_ioservers	Number of I/O servers.
num_log_span	Num.
num_quantiles	Number of quantiles retained.
numarchretry	Number of log archive retries on error.
number_compat	Detailed documentation not (yet) available.
numsegs	Detailed documentation not (yet) available.
opt_direct_wrkld	Detailed documentation not (yet) available.
overflowlogpath	Overflow log path.
page_age_trgt_gcr	Detailed documentation not (yet) available.
page_age_trgt_mcr	Target for oldest page in LBP.
pagesize	Detailed documentation not (yet) available.
pckcachesz	Package cache size (4KB).
pl_stack_trace	Procedural language stack trace.
priv_mem_thresh	Detailed documentation not (yet) available.
provider	resource.
rec_his_retentn	Recovery history retention (days).
repl_site_id	Replication site ID.
restore_pending	Detailed documentation not (yet) available.
restrict_access	Detailed documentation not (yet) available.
rollfwd_pending	Detailed documentation not (yet) available.
section_actuals	Section actuals setting.
self_tuning_mem	Self tuning memory.
seqdetect	Sequential detect flag.
sheapthres_shr	Sort heap thres for shared sorts (4KB).
smtp_server	SMTP Server.
softmax	Percent log file reclaimed before soft chckpt.
sortheap	Sort list heap (4KB).
sql_ccflags	SQL conditional compilation flags.
stat_heap_sz	Statistics heap size (4KB).
stmt_conc	Statement concentrator.
stmtheap	SQL statement heap (4KB).
string_units	Default string units.
suspend_io	Detailed documentation not (yet) available.
systime_period_adj	Adjust temporal SYSTEM_TIME period.
territory	Detailed documentation not (yet) available.
trackmod	Track modified pages.
tsm_mgmtclass	TSM management class.
tsm_nodename	TSM node name.
tsm_owner	TSM owner.
tsm_password	TSM password.
user_exit_status	Detailed documentation not (yet) available.
util_heap_sz	Utilities heap size (4KB).
varchar2_compat	Detailed documentation not (yet) available.
vendoropt	Vendor options.
wlm_admission_ctrl	WLM admission control enabled.
wlm_agent_load_trgt	Target agent load per CPU core.
wlm_collect_int	WLM Collection Interval (minutes).
wlm_cpu_limit	Maximum allowable CPU utilization (%).
wlm_cpu_share_mode	CPU share behavior (hard/soft).
wlm_cpu_shares	Allocated share of CPU resources.

act_sortmem_limit

Detailed documentation not (yet) available.

Back to overview of db2_database

allow_restart

Allow puppet to do a restart of the database.

Determine if you will allow Puppet to do a restart of the database if it detects that a restart is required to activate some changes.

Back to overview of db2_database

alt_collate

Alternate collating sequence.

Back to overview of db2_database

app_ctl_heap_sz

Detailed documentation not (yet) available.

Back to overview of db2_database

appgroup_mem_sz

Detailed documentation not (yet) available.

Back to overview of db2_database

appl_memory

Application Memory Size (4KB).

Back to overview of db2_database

applheapsz

Default application heap (4KB).

Back to overview of db2_database

archretrydelay

Log archive retry Delay (secs).

Back to overview of db2_database

authn_cache_duration

Lifetime of cached credentials.

Back to overview of db2_database

authn_cache_users

Max number of users in the cache.

Back to overview of db2_database

auto_cg_stats

Automatic column group statistic.

Back to overview of db2_database

auto_db_backup

Automatic database backup.

Back to overview of db2_database

auto_del_rec_obj

Auto deletion of recovery objects.

Back to overview of db2_database

auto_maint

Automatic maintenance.

Back to overview of db2_database

auto_reorg

Automatic reorganization.

Back to overview of db2_database

auto_reval

Auto-Revalidation.

Back to overview of db2_database

auto_runstats

Automatic runstats.

Back to overview of db2_database

auto_sampling

Automatic sampling.

Back to overview of db2_database

auto_stats_views

Statistical views.

Back to overview of db2_database

auto_stmt_stats

Real-time statistics.

Back to overview of db2_database

auto_tbl_maint

Automatic table maintenance.

Back to overview of db2_database

autorestart

Auto restart enabled.

Back to overview of db2_database

avg_appls

Average number of active applications.

Back to overview of db2_database

backup_pending

Detailed documentation not (yet) available.

Back to overview of db2_database

blk_log_dsk_ful

Block log on disk full.

Back to overview of db2_database

blocknonlogged

Block non logged operations.

Back to overview of db2_database

catalogcache_sz

Catalog cache size (4KB).

Back to overview of db2_database

cf_catchup_trgt

Detailed documentation not (yet) available.

Back to overview of db2_database

cf_db_mem_sz

Detailed documentation not (yet) available.

Back to overview of db2_database

cf_gbp_sz

Detailed documentation not (yet) available.

Back to overview of db2_database

cf_lock_sz

Detailed documentation not (yet) available.

Back to overview of db2_database

cf_sca_sz

Detailed documentation not (yet) available.

Back to overview of db2_database

chngpgs_thresh

Changed pages threshold.

Back to overview of db2_database

codepage

Detailed documentation not (yet) available.

Back to overview of db2_database

codeset

Detailed documentation not (yet) available.

Back to overview of db2_database

collate_info

Detailed documentation not (yet) available.

Back to overview of db2_database

connect_proc

Connect procedure.

Back to overview of db2_database

ctrl_file_recov_path

Detailed documentation not (yet) available.

Back to overview of db2_database

cur_commit

Currently Committe.

Back to overview of db2_database

database_consistent

Detailed documentation not (yet) available.

Back to overview of db2_database

database_level

Detailed documentation not (yet) available.

Back to overview of db2_database

database_memory

Size of database shared memory (4KB).

Back to overview of db2_database

database_name

The name of the database.

Back to overview of db2_database

date_compat

Detailed documentation not (yet) available.

Back to overview of db2_database

db_mem_thresh

Database memory threshold.

Back to overview of db2_database

dbheap

Database heap (4KB).

Back to overview of db2_database

ddl_compression_def

Enable row compression by default.

Back to overview of db2_database

ddl_constraint_def

Enforce Constraint.

Back to overview of db2_database

dec_arithmetic

DECIMAL arithmetic mode.

Back to overview of db2_database

dec_to_char_fmt

CHAR output with DECIMAL input.

Back to overview of db2_database

decflt_rounding

Decimal floating point rounding mode.

Back to overview of db2_database

dft_degree

Degree of parallelis.

Back to overview of db2_database

dft_extent_sz

Default tablespace extentsize (pages).

Back to overview of db2_database

dft_loadrec_ses

Default number of loadrec sessions.

Back to overview of db2_database

dft_mttb_types

Default maintained table types for op.

Back to overview of db2_database

dft_prefetch_sz

Default prefetch size (pages).

Back to overview of db2_database

dft_queryopt

Default query optimization class.

Back to overview of db2_database

dft_refresh_age

Default refresh age.

Back to overview of db2_database

dft_schemas_dcc

Default data capture on new Schemas.

Back to overview of db2_database

dft_sqlmathwarn

Continue upon arithmetic exceptions.

Back to overview of db2_database

dft_table_org

Default table organization.

Back to overview of db2_database

disable_corrective_change

Disable the modification of a resource when Puppet decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of db2_database

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet decides is a corrective change.

(requires easy_type V2.11.0 or higher)

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of db2_database

discover_db

Discovery support for this database.

Back to overview of db2_database

dlchktime

Interval for checking deadlock (ms).

Back to overview of db2_database

enable_xmlchar

Enable XML Character operations.

Back to overview of db2_database

encrlib

Encryption Library for Backup.

Back to overview of db2_database

encropts

Encryption Options for Backup.

Back to overview of db2_database

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of db2_database

extbl_location

Allowed paths for external table.

Back to overview of db2_database

extbl_strict_io

Strict I/O for EXTBL_LOCATION.

Back to overview of db2_database

extended_row_sz

Extended row size support.

Back to overview of db2_database

failarchpath

Failover log archive path.

Back to overview of db2_database

groupheap_ratio

Detailed documentation not (yet) available.

Back to overview of db2_database

hadr_db_role

Detailed documentation not (yet) available.

Back to overview of db2_database

hadr_local_host

HADR local host name.

Back to overview of db2_database

hadr_local_svc

HADR local service name.

Back to overview of db2_database

hadr_peer_window

HADR peer window duration (seconds).

Back to overview of db2_database

hadr_remote_host

HADR remote host name.

Back to overview of db2_database

hadr_remote_inst

HADR instance name of remote server.

Back to overview of db2_database

hadr_remote_svc

HADR remote service name.

Back to overview of db2_database

hadr_replay_delay

HADR log replay delay (seconds).

Back to overview of db2_database

hadr_role

The HADR role of the database. This is a readonly property.

Back to overview of db2_database

hadr_spool_limit

HADR spool log data limit (4KB).

Back to overview of db2_database

hadr_ssl_host_val

Detailed documentation not (yet) available.

Back to overview of db2_database

hadr_ssl_label

HADR SSL certificate label.

Back to overview of db2_database

hadr_syncmode

HADR log write synchronization mode.

Back to overview of db2_database

hadr_target_list

HADR target list.

Back to overview of db2_database

hadr_timeout

HADR timeout value.

Back to overview of db2_database

indexrec

Index re-creation time and redo index build.

Back to overview of db2_database

instance_name

The name of the instance.

Back to overview of db2_database

large_aggregation

Detailed documentation not (yet) available.

Back to overview of db2_database

locklist

Max storage for lock list (4KB).

Back to overview of db2_database

locktimeout

Lock timeout (sec).

Back to overview of db2_database

log_appl_info

Log Application Information.

Back to overview of db2_database

log_ddl_stmts

Log DDL Statements.

Back to overview of db2_database

log_disk_cap

Active log space disk capacity (MB).

Back to overview of db2_database

log_retain_status

Detailed documentation not (yet) available.

Back to overview of db2_database

logarchcompr1

Archive compression for logarchmeth1.

Back to overview of db2_database

logarchcompr2

Archive compression for logarchmeth2.

Back to overview of db2_database

logarchmeth1

First log archive method.

Back to overview of db2_database

logarchmeth2

Second log archive method.

Back to overview of db2_database

logarchopt1

Options for logarchmeth1.

Back to overview of db2_database

logarchopt2

Options for logarchmeth2.

Back to overview of db2_database

logbufsz

Log buffer size (4KB).

Back to overview of db2_database

logfilsiz

Log file size (4KB).

Back to overview of db2_database

loghead

Detailed documentation not (yet) available.

Back to overview of db2_database

logindexbuild

Log pages during index build.

Back to overview of db2_database

logpath

Detailed documentation not (yet) available.

Back to overview of db2_database

logprimary

Number of primary log files.

Back to overview of db2_database

logsecond

Number of secondary log files.

Back to overview of db2_database

max_log

Percent max primary log space by transaction.

Back to overview of db2_database

maxappls

Max number of active applications.

Back to overview of db2_database

maxfilop

Max DB files open per database.

Back to overview of db2_database

maxlocks

Percentage of lock lists per application.

Back to overview of db2_database

min_dec_div_3

Detailed documentation not (yet) available.

Back to overview of db2_database

mincommit

Detailed documentation not (yet) available.

Back to overview of db2_database

mirrorlogpath

Mirror log path.

Back to overview of db2_database

mon_act_metrics

Activity metrics.

Back to overview of db2_database

mon_deadlock

Deadlock events.

Back to overview of db2_database

mon_lck_msg_lvl

Lock event notification level.

Back to overview of db2_database

mon_locktimeout

Lock timeout events.

Back to overview of db2_database

mon_lockwait

Lock wait events.

Back to overview of db2_database

mon_lw_thresh

Lock wait event threshold.

Back to overview of db2_database

mon_obj_metrics

Object metrics.

Back to overview of db2_database

mon_pkglist_sz

Number of package list entries.

Back to overview of db2_database

mon_req_metrics

Request metrics.

Back to overview of db2_database

mon_rtn_data

Routine data.

Back to overview of db2_database

mon_rtn_execlist

Routine executable list.

Back to overview of db2_database

mon_uow_data

Unit of work events.

Back to overview of db2_database

mon_uow_execlist

UOW events with executable list.

Back to overview of db2_database

mon_uow_pkglist

UOW events with package list.

Back to overview of db2_database

multipage_alloc

Detailed documentation not (yet) available.

Back to overview of db2_database

name

The name of the database.

Back to overview of db2_database

nchar_mapping

National character string mapping.

Back to overview of db2_database

newlogpath

Changed path to log files.

Back to overview of db2_database

num_db_backups

Number of database backups to retain.

Back to overview of db2_database

num_freqvalues

Number of frequent values retained.

Back to overview of db2_database

num_iocleaners

Number of asynchronous page cleaners.

Back to overview of db2_database

num_ioservers

Number of I/O servers.

Back to overview of db2_database

num_log_span

Num. of active log files for 1 active UOW.

Back to overview of db2_database

num_quantiles

Number of quantiles retained.

Back to overview of db2_database

numarchretry

Number of log archive retries on error.

Back to overview of db2_database

number_compat

Detailed documentation not (yet) available.

Back to overview of db2_database

numsegs

Detailed documentation not (yet) available.

Back to overview of db2_database

opt_direct_wrkld

Detailed documentation not (yet) available.

Back to overview of db2_database

overflowlogpath

Overflow log path.

Back to overview of db2_database

page_age_trgt_gcr

Detailed documentation not (yet) available.

Back to overview of db2_database

page_age_trgt_mcr

Target for oldest page in LBP.

Back to overview of db2_database

pagesize

Detailed documentation not (yet) available.

Back to overview of db2_database

pckcachesz

Package cache size (4KB).

Back to overview of db2_database

pl_stack_trace

Procedural language stack trace.

Back to overview of db2_database

priv_mem_thresh

Detailed documentation not (yet) available.

Back to overview of db2_database

provider

The specific backend to use for this db2_database resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are: