TivoliFixedContentDevice Properties

This topic alphabetically lists the properties that apply to the TivoliFixedContentDevice class.

ClassDescription Property

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ClassDescription
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Creator Property

Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DateCreated Property

Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DATE
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DateLastModified Property

Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DATE
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DescriptiveText Property

User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DisplayName Property

The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FcpPoolIdleTimeoutSeconds Property

The number of seconds an idle connection can remain in the fixed content device provider pool before being eligible to be closed and removed from the pool. An idle connection will be closed when the next operation to the same fixed content device is performed after this idle period.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  300
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FcpPoolMaxInUse Property

The maximum number of concurrent connections allowed for the fixed content device. A value of -1 indicates that there is no limit.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  30
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FcpPoolMaxWaitSeconds Property

The maximum number of seconds to wait for a connection once the limit specified by the FcpPoolMaxInUse property has been reached. If a connection from the fixed content device provider pool does become available before this wait time expires, the request is allowed to proceed.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  5
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FcpPoolPreferredSize Property

The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  5
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

Id Property

A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ImplementationClass Property

Specifies the name of the fixed content provider class that implements the behavior for a fixed content device. The classes include:

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  255
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

LastModifier Property

Indicates the name of the user who last modified this object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

SiteSettings Property

Specifies the SiteSettings objects associated with a fixed content device. Site settings provide site-specific, configuration value overrides. For each fixed content device type with settings that can be overridden, a corresponding subclass of SiteSettings is defined with properties that, if populated, will override the corresponding properties of the same name on the fixed content device object.

For an EMC Centera fixed content device, this property allows the PoolAddress property to be different, depending on the site in which the Content Engine server is running. If the Content Engine server is running in a site that does not correspond to one of the SiteSetting objects, then the PoolAddress property on the CenteraFixedContentDevice object is used as the default.

For a FileNet Image Services fixed content device, this property allows the CSMCache property to be different depending on the site in which the Content Engine server is running. If the Content Engine server is running in a site that does not correspond to one of the SiteSetting objects, then the CSMCache property on the IMFixedContentDevice object is used as the default.

For a NetApp SnapLock fixed content device, there are currently no properties that may be customized for a site.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  SiteSettings
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMApplicationType Property

A string, such as "FileNetP8", that identifies the application type of the client (Content Engine server) to the IBM® Tivoli® Storage Manager server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMArchiveProtectionFlag Property

Specifies whether data retention protection is enabled on the IBM® Tivoli® Storage Manager (TSM) server (true) or not (false). This property corresponds to the ENABLEARCHIVERETENTIONPROTECTION option in a TSM options file and must match the data retention protection setting on the TSM server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  true
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMCompressionFlag Property

Specifies whether files will be compressed before they are sent to the IBM® Tivoli® Storage Manager (TSM) server (true) or not (false). This property corresponds to the COMPression option in a TSM options file.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  true
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMConfigurationFilesShare Property

The full path of the root directory that contains the configuration options files for the IBM® Tivoli® Storage Manager (TSM) server. This directory must already exist and must be shared so that the Content Engine system user has read/write access. You should not modify these configuration options files directly; they are written to by the Content Engine server whenever various TivoliFixedContentDevice object properties are changed. Because the TSM server cannot run if these files are missing or damaged, you should back them up frequently.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  2083
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMDSMIDirectory Property

If this property is set, it indicates that the Content Engine (CE) server is connected to the IBM® Tivoli® Storage Manager (TSM) server as a UNIX TSM client and specifies the full path of the client directory containing the dsmtca and dsm.sys files. Otherwise, if this property is not set, it indicates that the CE server is connected to the TSM server as a Microsoft® Windows® TSM client.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  2083
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMFilespaceName Property

The name of the file space used by the client node (Content Engine server) to connect to an IBM® Tivoli® Storage Manager (TSM) server. A file space maps a TSM client node to a particular file system on the client machine. The file space name must begin with a forward slash (“/”).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  2083
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMManagementClasses Property

A collection of the CmTivoliManagementClass management classes associated with a TivoliFixedContentDevice class. Each management class represents a specific retention setting, which consists of a retention scheme type and a retention period, that can be applied to an IBM® Tivoli® Storage Manager server.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  CmTivoliManagementClass
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

TSMMountWaitDuration Property

This property is not supported.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  0
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMNodeName Property

The name of the client node (Content Engine server) to connect to the IBM® Tivoli® Storage Manager (TSM) server. All Content Engine objects that are archived on the TSM server will be accessed using this client node name. The client node must be configured to have proper read/write access and must be allowed to make multiple connections to the TSM server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMOptions Property

A string containing configuration options that are passed to the IBM® Tivoli® Storage Manager (TSM) server by the TSM client (Content Engine server). These configuration options override the settings specified in the TSM options files. This string is not normally used and can contain P8-specific data that is not passed to the TSM server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  2083
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMOwnerName Property

The owner name for controlling access to the Content Engine objects that are archived using the IBM® Tivoli® Storage Manager server. This property is included for legacy reasons and is normally left blank.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMPassword Property

The password of the client node (Content Engine server) that connects to the IBM® Tivoli® Storage Manager server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BINARY
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMPort Property

The port number of the IBM® Tivoli® Storage Manager (TSM) server. This property corresponds to the tcpport option in a TSM options file.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  1500
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMServerAddress Property

The IP address or computer name of the IBM® Tivoli® Storage Manager (TSM) server. This property corresponds to the TCPSERVERADDRESS option in a TSM options file.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TSMWriteBufferSize Property

The buffer size, in bytes, to use when transferring content data from the Content Engine to the IBM® Tivoli® Storage Manager server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  65536
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

VendorName Property

Specifies a vendor name.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  256
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ