This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Config.Cluster

persistent class Config.Cluster extends %Library.Persistent, Config.CommonSingleMethods, Config.CommonProperties, %SYSTEM.Help

SQL Table Name: Config.Cluster

This class allows you to modify and view the [Cluster] section of the CPF file through programatic APIs. While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Get/Modify) to modify the properties by passing in the correct parameters, or use Object sytax to open and directly manipulate the config objects.

EXAMPLE:

; Use class methods to modify properties
%SYS>s Status=##Class(Config.Cluster).Get(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("CommIPAddress")=""
Properties("JoinCluster")=0
%SYS>s Properties("JoinCluster")=1
%SYS>s Status=##Class(Config.Cluster).Modify(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.Cluster).Open()
%SYS>w Obj.JoinCluster
1
%SYS>s Obj.JoinCluster=0
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory (Including Private)

Properties

property CommIPAddress as %String (MAXLEN = 128, MINLEN = 0);
Defines the IP Address to advertise in the PIJ to the other cluster members.
Property methods: CommIPAddressDisplayToLogical(), CommIPAddressGet(), CommIPAddressGetStored(), CommIPAddressIsValid(), CommIPAddressLogicalToDisplay(), CommIPAddressLogicalToOdbc(), CommIPAddressNormalize(), CommIPAddressSet()
property JoinCluster as Security.Datatype.BooleanYN [ InitialExpression = 0 , Required ];
Set to True if this configuration is part of a cluster.
Property methods: JoinClusterDisplayToLogical(), JoinClusterGet(), JoinClusterGetStored(), JoinClusterIsValid(), JoinClusterLogicalToDisplay(), JoinClusterLogicalToODBC(), JoinClusterLogicalToXSD(), JoinClusterNormalize(), JoinClusterSet(), JoinClusterXSDToLogical()

Indices

index (CPFNameSectionHeaderName on CPFName,SectionHeader,Name) [IdKey, Type = key, Unique];
Index methods: CPFNameSectionHeaderNameCheck(), CPFNameSectionHeaderNameDelete(), CPFNameSectionHeaderNameExists(), CPFNameSectionHeaderNameOpen(), CPFNameSectionHeaderNameSQLCheckUnique(), CPFNameSectionHeaderNameSQLExists(), CPFNameSectionHeaderNameSQLFindPKeyByConstraint(), CPFNameSectionHeaderNameSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (Config.Cluster)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)
=
%%CLASSNAME
CommIPAddress
JoinCluster
Comments
Feedback