dbamconfig

Synopsis

dbamconfig
-c -D data_device[,block_type1[=size1 {MB | GB}]
…
[,block_type6[=size6 {MB | GB}]]
[-D…] …
-T translog_device
-P profile_name |
-d -P {profile_name | ALL} |
-s [-l] [-P {profile_name | ALL}] |
-V

Purpose

Creates, deletes, and displays the properties of a database profile. A profile describes the location and layout of a DirX Directory database (number, size and relationship of physical (raw) device(s) and the usage of the device(s) for the different database block types).

Options

-c

Creates a database profile with the name specified in the -P option.

-D data_device[,*block_type1[=size1 \{*MB | GB}]…[,*block_type6[=size6 \{*MB | GB}]]

Describes a raw (physical) device to be used as a directory data device where:
- data_device is the name of the device; for example, /dev/rdsk/c0t0s0s1 (Linux). On Windows, it is the full path of the NTFS folder in that the raw device was mounted with the local disk manager, for example D:\RawDevices\OrgDB. Assigning a drive letter to the raw device is prohibited on Windows.
- block_type specifies up to six different type(s) of directory data to be stored, and
- size specifies the size of the associated block_type in the device.
Use one of the following keywords to specify block_type:
- AVIDX—The device stores attribute value index blocks
- BITSTR—The device stores bit string blocks
- GENERAL—The device stores general blocks
- PSEUDO—The device stores pseudo object blocks
- REAL—The device stores real object blocks
- TREE—The device stores tree blocks
Specify size as an integer in the range 1 through 9999 followed by the keyword MB (to specify the size in megabytes) or GB (to specify the size in gigabytes).
Use one or more -D options to specify one or more raw devices to be used as directory data devices for the database. This option is only valid with the -c option.
The maximum device sizes are the following:
- REAL device:
  
  The maximum size of a REAL object block device is 1TB (1024 GB). This limit depends on the chosen size of the real object blocks and the maximum number of entries. The real object block size is specified in the –o option of the dbamboot command. The following table illustrates this relationship:
  
  Block Size
  
  Maximum number of entries
  
  Device Size
  
  1k
  
  536870911
  
  512 GB
  
  4k
  
  268435456
  
  1024 GB
  
  16k
  
  67108864
  
  1024 GB
  
  64k
  
  16777216
  
  1024 GB
  
  DBAM stores one entry with all its attributes in one real object block and in follow blocks. The maximum number of follow blocks used for one entry is limited to 8192. Follow blocks are stored in the GENERAL device (see below). Therefore the maximum size of an entry is (8193 * REAL BLOCK size); for example, if the REAL BLOCK size is 1KB, the maximum size for one entry is 8193 KB.
- AVIDX device:
  
  The disk space in an AVIDX device is managed by clusters in sizes of 8 MB, 32 MB and 128 MB. dbamboot calculates the appropriate cluster size. This cluster size cannot modified during the life time of the database. The maximum device size is 409 GB because the maximum allowable cluster number of DBAM is 3276 clusters.
- GENERAL, BITSTR, PSEUDO, TREE device:
  
  The maximum size of these devices is 128 GB per device. You can specify a seperate device for each block type that is each device can consume the maximum available disk space, or you can combine several block types in one device that is these block types share the maximum available disk space.
If any of the limitations above is exceeded dbamconfig aborts with the error message Internal limits exceeded.

–T translog_device

The name of the raw (physical) device to be used as a transaction data device. For example, /dev/rdsk/c0t0s0s2 (Linux) or D:\RawDevices\OrgTranslog (Windows). (See data_device of the -D option for details on the raw device name.)

You must provide at least is 256 MB for the tranlog device. For best performance the size of the translog device should increase with the DBAM cache size and the checkpoint size. A good way to calculate the optimum size is to multiply the DBAM cache size by two (2). A translog device size of 4 GB performs well even for very large DBAM cache sizes (greater than 4 GB).

This option is only valid with the -c option.

-P profile_name

-P \{profile_name | ALL}

The name of a database profile. This option must be used with the -c and -d options, and is optional for the -s option. The maximum size of a database profile name is 32 characters.

If the keyword ALL is used with the -d or -s option all existing database profiles are deleted or displayed.

-d

Deletes the database profile(s) specified in the -P option if it is not the current active profile.

-s

Displays the properties of the profile(s) specified in the -P option. If no -P option is specified the properties of all existing profiles are displayed.

-l

Displays a detailed list of database profile properties.

-V

Displays the DirX Directory product version, in the format:

product_version build_id date time

For example:

DirX Directory V9.0 9.4.428 2023:03:23 20:10 64-Bit

Description

The dbamconfig command creates a profile for a DBAM database, deletes (a) profile(s), and displays the properties of a selected profile or all profiles.

Before you can use dbamconfig, you must:

Provide disk space for the database(s).

Use the -c option to create a profile for a DirX Directory database. Use one or more -D options to specify one or more raw devices to be used as directory data devices for the database. The -T option specifies the raw device to be used as the transaction device for the database. The -P option specifies the name for the profile.

If you specify a single data device and you do not explicitly specify the block type and the size of the device, the dbamconfig command allocates forty percent of the raw device for the REAL block type, forty percent for the AVIDX block type. The remaining twenty percent of the device are shared by the other block types.

If you specify more than one data device, dbamconfig allocates any block types that you do not explicitly specify on one of the raw devices that has the required disk space. If none of the devices in the configuration have sufficient disk space for this block type, the profile cannot be created and the operation fails.

Use the -d option to remove a profile for a DirX Directory database. It is prohibited to delete the current active profile. The DSA logs the name of the current active profile in the file install_path*/server/log/fatalDSA**. If you need to extend your database because the DBAM device limits have been exceeded then follow the procedure as described in the chapter titled “Extending the Directory Database” in the Disc Dimensioning Guide.

Use the -s option to display the properties of a profile for a DirX Directory database.

Examples

The following sample command creates a profile for a DirX Directory database of one data device and one transaction device on Windows.
```
dbamconfig -c –D D:\RawDevices\OrgDB
              –T D:\RawDevices\OrgTranslog
              –P OrgProfile
```
The following sample command creates a profile for a DirX Directory database of one data device and one transaction device on Linux.
```
dbamconfig -c –D /dev/rdsk/c0t0d0s1
              –T /dev/rdsk/c0t0d0s2
              –P profile1
```
The following sample command creates a profile for a DirX Directory database of one data device and one transaction device on Linux. In this example, 20GB of the 36GB raw device used as the data device are allocated for the block type REAL, 10GB are allocated for the block type AVIDX, and the remaining 6GB are shared by the remaining block types.
```
dbamconfig -c –D /dev/rdsk/c0t0d0s1,REAL=20GB,AVIDX=10GB
              -T /dev/rdsk/c0t0d0s2 –P profile2
```
The following sample command creates a profile for a DirX Directory database of 3 data devices and a transaction device on Linux. In this example, the first data device is allocated for block type REAL, the second data device is allocated for block type AVIDX, and in the third data device 5GB are allocated for the TREE block type and the remaining space is shared by the remaining block types.
```
dbamconfig -c –D /dev/rdsk/c0t0d0s1,REAL
              -D /dev/rdsk/c0t0d0s2,AVIDX
              -D /dev/rdsk/c0t0d0s3,TREE=5GB
              -T /dev/rdsk/c0t0d0s2
              –P profile3
```
The following sample command displays a summary of the properties of all profiles that exist in the profile directory.
```
dbamconfig -s –P ALL
```
The following sample command displays the details of a profile.
```
dbamconfig -s -l -Pprofile1
```

The following sample command displays the details of all profiles.

dbamconfig -s –l

The command output is as follows:

  ProfileName: OrgProfile
    DataDevice(s):
      Mountpoint: D:\RawDevices\OrgDB\
      VolumeName: \\?\Volume{cc42f0fb-8355-11d6-a05c-009027ca3eba}
      DeviceSize: 29.293 GB
        Logical device(s):
          BlockType(s): GENERAL | BITSTR | PSEUDO | TREE
          DeviceSize:   5.857 GB

          BlockType(s): REAL
          DeviceSize:   11.714 GB

          BlockType(s): AVIDX
          DeviceSize:   11.714 GB

    TransactionDevice:
      Mountpoint: D:\RawDevices\OrgTranslog\
      VolumeName: \\?\Volume{cc42f0fd-8355-11d6-a05c-009027ca3eba}
      DeviceSize: 4.742 GB

Exit Codes

The dbamconfig command returns an exit code of 0 on success or a 1 if it encountered an error. The text of the error message is displayed on stderr.