Overview

This resource allows you to manage an DB2 instance. Here is an example on how to use this:

db2_instance { 'db2inst2':
  ensure              => 'present',
  agent_stack_sz      => 1024,
  agentpri            => 'SYSTEM',
  alternate_auth_enc  => 'AES_ONLY',
  aslheapsz           => 15,
  audit_buf_sz        => 1000,
  authentication      => 'SERVER_ENCRYPT',
  catalog_noauth      => 'NO',
}

Manage the OS user or not

If the manage_user parameter is set to true, Puppet will create the OS users required for an instance. If you need more control over the creation process, you can set the parameter to false and manage the user(s) yourself. Look at the parameters:

  • instance_password
  • instance_uid
  • instance_group
  • instance_home
  • fence_user
  • fence_password
  • fence_uid
  • fence_group
  • fence_home

for more details.

When removing an instance, the parameter will determine if Puppet removes the OS users.

Attributes

Attribute Name Short Description
agent_stack_sz Agent stack size.
agentpri Priority of agents.
alt_diagpath Alternate diagnostic data directory path.
alternate_auth_enc Alternate authentication.
aslheapsz Application support layer heap size (4KB).
audit_buf_sz Audit buffer size (4KB).
authentication Database manager authentication.
authentication_type The type of autentication to use for the instance.
catalog_noauth Cataloging allowed without authority.
clnt_krb_plugin Client Kerberos Plugin.
clnt_pw_plugin Client Userid-Password Plugin.
comm_bandwidth Communications bandwidth (MB/sec).
comm_exit_list Communication buffer exit library list.
conn_elapse Node connection elapse time (sec).
cpuspeed CPU speed (millisec/instruction).
cur_eff_arch_lvl Current effective arch level.
cur_eff_code_lvl Current effective code level.
datalinks Detailed documentation not (yet) available.
dft_account_str Default charge-back account.
dft_mon_bufpool Default database monitor switches for Buffer pool.
dft_mon_lock Default database monitor switches for Lock.
dft_mon_sort Default database monitor switches for Sort.
dft_mon_stmt Default database monitor switches for Statement.
dft_mon_table Default database monitor switches for Table.
dft_mon_timestamp Default database monitor switches for Timestamp.
dft_mon_uow Default database monitor switches for Unit of Work.
dftdbpath Default database path.
diaglevel Diagnostic error capture level.
diagpath Diagnostic data directory path.
diagsize Size of rotating db2diag & notify logs (MB).
dir_cache Directory cache support.
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 Discovery mode.
discover_inst Discover server instance.
ensure The basic property that the resource should be in.
fcm_buffer_size FCM buffer size.
fcm_num_buffers Number of FCM buffers.
fcm_num_channels Number of FCM channels.
fcm_parallelism FCM parallelism.
fed_noauth Bypass federated authentication.
federated Federated Database System Support.
federated_async Maximum Asynchronous TQs per query.
fence_group The group of the fence user to be created.
fence_home The home of the fence user to be created.
fence_password The password of the fence user to be created.
fence_uid The uid of the fence user to be created.
fence_user The name of the fence user to be created.
fenced_pool Number of pooled fenced processes.
group_plugin Group Plugin.
health_mon Monitor health of instance and databases.
indexrec Index re-creation time and redo index build.
instance_group The group of the instance user to be created.
instance_home The home of the instance user to be created.
instance_memory Global instance memory (% or 4KB).
instance_password The password of the instance user to be created.
instance_type The type of instance to create.
instance_uid The uid of the instance user to be created.
intra_parallel Enable intra-partition parallelis.
java_heap_sz Java Virtual Machine heap size (4KB).
jdk_path Java Development Kit installation path.
keepfenced Keep fenced process.
keystore_location Keystore location.
keystore_type Keystore type.
local_gssplugin GSS Plugin for Local Authorization.
location The location of the software the instance is running from.
manage_users If set to true the db2_instance type manages the instance and fence users.
max_connections Max number of client connection.
max_connretries Max number of node connection retries.
max_coordagents Max number of coordinating agents.
max_querydegree Maximum query degree of parallelism.
max_time_diff Max time difference between nodes (min).
mon_heap_sz Database monitor heap size (4KB).
name The name of the instance.
notifylevel Notify Level.
num_initagents Initial number of agents in pool.
num_initfenced Initial number of fenced processes.
num_poolagents Agent pool size.
numdb Max number of concurrently active database.
port The IP port the instance will use.
provider resource.
python_path Path to python runtime.
restart Specifies if you want to automaticaly want to restart after the change has been applied.
resync_interval Transaction resync interval (sec).
rqrioblk Max requester I/O block size (bytes).
sheapthres Sort heap threshold (4KB).
spm_log_file_sz SPM log size.
spm_log_path SPM log path.
spm_max_resync SPM resync agent limit.
spm_name SPM name.
srv_plugin_mode Server Plugin Mode.
srvcon_auth Server Connection Authentication.
srvcon_gssplugin_list Detailed documentation not (yet) available.
srvcon_pw_plugin Detailed documentation not (yet) available.
ssl_cipherspecs SSL cipher specs.
ssl_clnt_keydb SSL client keydb file.
ssl_clnt_stash SSL client stash file.
ssl_svcename SSL service name.
ssl_svr_keydb SSL server keydb file.
ssl_svr_label SSL server certificate label.
ssl_svr_stash SSL server stash file.
ssl_versions SSL versions.
start_stop_time db2start/db2stop timeout (min).
state The state of the database manager in the instance.
svcename TCP/IP Service name.
sysadm_group SYSADM group name.
sysctrl_group SYSCTRL group name.
sysmaint_group SYSMAINT group name.
sysmon_group SYSMON group name.
tm_database Transaction manager database name.
tp_mon_name Transaction processor monitor name.
trust_allclnts Trust all clients.
trust_clntauth Trusted client authentication.
util_impact_lim Workload impact by throttled utilities.
wlm_disp_concur WLM dispatcher concurrency.
wlm_disp_cpu_shares WLM dispatcher CPU shares enabled.
wlm_disp_min_util WLM dispatcher min.
wlm_dispatcher WLM dispatcher enabled.

agent_stack_sz

Agent stack size.

Back to overview of db2_instance

agentpri

Priority of agents.

Back to overview of db2_instance

alt_diagpath

Alternate diagnostic data directory path.

Back to overview of db2_instance

alternate_auth_enc

Alternate authentication.

Back to overview of db2_instance

aslheapsz

Application support layer heap size (4KB).

Back to overview of db2_instance

audit_buf_sz

Audit buffer size (4KB).

Back to overview of db2_instance

authentication

Database manager authentication.

Back to overview of db2_instance

authentication_type

The type of autentication to use for the instance.

Back to overview of db2_instance

catalog_noauth

Cataloging allowed without authority.

Back to overview of db2_instance

clnt_krb_plugin

Client Kerberos Plugin.

Back to overview of db2_instance

clnt_pw_plugin

Client Userid-Password Plugin.

Back to overview of db2_instance

comm_bandwidth

Communications bandwidth (MB/sec).

Back to overview of db2_instance

comm_exit_list

Communication buffer exit library list.

Back to overview of db2_instance

conn_elapse

Node connection elapse time (sec).

Back to overview of db2_instance

cpuspeed

CPU speed (millisec/instruction).

Back to overview of db2_instance

cur_eff_arch_lvl

Current effective arch level.

Back to overview of db2_instance

cur_eff_code_lvl

Current effective code level.

Back to overview of db2_instance

Detailed documentation not (yet) available.

Back to overview of db2_instance

dft_account_str

Default charge-back account.

Back to overview of db2_instance

dft_mon_bufpool

Default database monitor switches for Buffer pool.

Back to overview of db2_instance

dft_mon_lock

Default database monitor switches for Lock.

Back to overview of db2_instance

dft_mon_sort

Default database monitor switches for Sort.

Back to overview of db2_instance

dft_mon_stmt

Default database monitor switches for Statement.

Back to overview of db2_instance

dft_mon_table

Default database monitor switches for Table.

Back to overview of db2_instance

dft_mon_timestamp

Default database monitor switches for Timestamp.

Back to overview of db2_instance

dft_mon_uow

Default database monitor switches for Unit of Work.

Back to overview of db2_instance

dftdbpath

Default database path.

Back to overview of db2_instance

diaglevel

Diagnostic error capture level.

Back to overview of db2_instance

diagpath

Diagnostic data directory path.

Back to overview of db2_instance

diagsize

Size of rotating db2diag & notify logs (MB).

Back to overview of db2_instance

dir_cache

Directory cache support.

Back to overview of db2_instance

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_instance

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)

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_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_instance

discover

Discovery mode.

Back to overview of db2_instance

discover_inst

Discover server instance.

Back to overview of db2_instance

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of db2_instance

fcm_buffer_size

FCM buffer size.

Back to overview of db2_instance

fcm_num_buffers

Number of FCM buffers.

Back to overview of db2_instance

fcm_num_channels

Number of FCM channels.

Back to overview of db2_instance

fcm_parallelism

FCM parallelism.

Back to overview of db2_instance

fed_noauth

Bypass federated authentication.

Back to overview of db2_instance

federated

Federated Database System Support.

Back to overview of db2_instance

federated_async

Maximum Asynchronous TQs per query.

Back to overview of db2_instance

fence_group

The group of the fence user to be created. The fence group will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

fence_home

The home of the fence user to be created. The fence user and home will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

fence_password

The password of the fence user to be created. The fence user will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

fence_uid

The uid of the fence user to be created. The fence user will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

fence_user

The name of the fence user to be created. The fence user will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

fenced_pool

Number of pooled fenced processes.

Back to overview of db2_instance

group_plugin

Group Plugin.

Back to overview of db2_instance

health_mon

Monitor health of instance and databases.

Back to overview of db2_instance

indexrec

Index re-creation time and redo index build.

Back to overview of db2_instance

instance_group

The group of the instance user to be created. The instance user will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

instance_home

The home of the instance user to be created. The instance user and home will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

instance_memory

Global instance memory (% or 4KB).

Back to overview of db2_instance

instance_password

The password of the instance user to be created. The instance user will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

instance_type

The type of instance to create.

The following types are available:

  • dsf - Used to create a Db2 pureScale instance for a Db2 database server with local and remote clients. This option is the default instance type for the IBM Db2 pureScale Feature.
  • ese - Used to create an instance for a database server with local and remote clients. This option is the default instance type for Db2 Advanced Enterprise Server Edition, Db2 Advanced Workgroup Server Edition, Db2 Enterprise Server Edition, or Db2 Workgroup Server Edition.
  • wse - Used to create an instance for a database server with local and remote clients. This option is the default instance type for Db2 Express-C, and Db2 Connect Enterprise Edition.
  • standalone - Used to create an instance for a database server with local clients.
  • client - Used to create an instance for a client. This option is the default instance type for IBM Data Server Client, and IBM Data Server Runtime Client.

Back to overview of db2_instance

instance_uid

The uid of the instance user to be created. The instance user will only be created (or removed when instance set to absent) when the parameter manage_user is set to true.

Back to overview of db2_instance

intra_parallel

Enable intra-partition parallelis.

Back to overview of db2_instance

java_heap_sz

Java Virtual Machine heap size (4KB).

Back to overview of db2_instance

jdk_path

Java Development Kit installation path.

Back to overview of db2_instance

keepfenced

Keep fenced process.

Back to overview of db2_instance

keystore_location

Keystore location.

Back to overview of db2_instance

keystore_type

Keystore type.

Back to overview of db2_instance

local_gssplugin

GSS Plugin for Local Authorization.

Back to overview of db2_instance

location

The location of the software the instance is running from.

Back to overview of db2_instance

manage_users

If set to true the db2_instance type manages the instance and fence users. When an instance is created, Puppet will create the user(s). If the isstance is set to absent, Puppet will remove the user(s)

Back to overview of db2_instance

max_connections

Max number of client connection.

Back to overview of db2_instance

max_connretries

Max number of node connection retries.

Back to overview of db2_instance

max_coordagents

Max number of coordinating agents.

Back to overview of db2_instance

max_querydegree

Maximum query degree of parallelism.

Back to overview of db2_instance

max_time_diff

Max time difference between nodes (min).

Back to overview of db2_instance

mon_heap_sz

Database monitor heap size (4KB).

Back to overview of db2_instance

name

The name of the instance.

Back to overview of db2_instance

notifylevel

Notify Level.

Back to overview of db2_instance

num_initagents

Initial number of agents in pool.

Back to overview of db2_instance

num_initfenced

Initial number of fenced processes.

Back to overview of db2_instance

num_poolagents

Agent pool size.

Back to overview of db2_instance

numdb

Max number of concurrently active database.

Back to overview of db2_instance

port

The IP port the instance will use.

Back to overview of db2_instance

provider

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

db2
Manage an Db2 instance

Back to overview of db2_instance

python_path

Path to python runtime.

Back to overview of db2_instance

restart

Specifies if you want to automaticaly want to restart after the change has been applied. Some changes to the database manager will only become active after a restart of the database manager.

db2_instance { 'db2inst1':
  ...
  restart   => true,
  ...
}

By default puppet will NOT restart the database manager

Valid values are true, false.

Back to overview of db2_instance

resync_interval

Transaction resync interval (sec).

Back to overview of db2_instance

rqrioblk

Max requester I/O block size (bytes).

Back to overview of db2_instance

sheapthres

Sort heap threshold (4KB).

Back to overview of db2_instance

spm_log_file_sz

SPM log size.

Back to overview of db2_instance

spm_log_path

SPM log path.

Back to overview of db2_instance

spm_max_resync

SPM resync agent limit.

Back to overview of db2_instance

spm_name

SPM name.

Back to overview of db2_instance

srv_plugin_mode

Server Plugin Mode.

Back to overview of db2_instance

srvcon_auth

Server Connection Authentication.

Back to overview of db2_instance

srvcon_gssplugin_list

Detailed documentation not (yet) available.

Back to overview of db2_instance

srvcon_pw_plugin

Detailed documentation not (yet) available.

Back to overview of db2_instance

ssl_cipherspecs

SSL cipher specs.

Back to overview of db2_instance

ssl_clnt_keydb

SSL client keydb file.

Back to overview of db2_instance

ssl_clnt_stash

SSL client stash file.

Back to overview of db2_instance

ssl_svcename

SSL service name.

Back to overview of db2_instance

ssl_svr_keydb

SSL server keydb file.

Back to overview of db2_instance

ssl_svr_label

SSL server certificate label.

Back to overview of db2_instance

ssl_svr_stash

SSL server stash file.

Back to overview of db2_instance

ssl_versions

SSL versions.

Back to overview of db2_instance

start_stop_time

db2start/db2stop timeout (min).

Back to overview of db2_instance

state

The state of the database manager in the instance.

Back to overview of db2_instance

svcename

TCP/IP Service name.

Back to overview of db2_instance

sysadm_group

SYSADM group name.

Back to overview of db2_instance

sysctrl_group

SYSCTRL group name.

Back to overview of db2_instance

sysmaint_group

SYSMAINT group name.

Back to overview of db2_instance

sysmon_group

SYSMON group name.

Back to overview of db2_instance

tm_database

Transaction manager database name.

Back to overview of db2_instance

tp_mon_name

Transaction processor monitor name.

Back to overview of db2_instance

trust_allclnts

Trust all clients.

Back to overview of db2_instance

trust_clntauth

Trusted client authentication.

Back to overview of db2_instance

util_impact_lim

Workload impact by throttled utilities.

Back to overview of db2_instance

wlm_disp_concur

WLM dispatcher concurrency.

Back to overview of db2_instance

wlm_disp_cpu_shares

WLM dispatcher CPU shares enabled.

Back to overview of db2_instance

wlm_disp_min_util

WLM dispatcher min. utilization (%).

Back to overview of db2_instance

wlm_dispatcher

WLM dispatcher enabled.

Back to overview of db2_instance