Skip to main content

HS.HC.ClientAPI.InstanceConfig.InstanceInfo

class HS.HC.ClientAPI.InstanceConfig.InstanceInfo extends HS.REST.Model.ISerializable

Model to represent instance wide information.

Property Inventory

Properties

property HSNetworkHostName as HS.HC.DataType.ServerName [ Required ];
Network Host Name as selected in the "Installer Wizard".
Property methods: HSNetworkHostNameDisplayToLogical(), HSNetworkHostNameGet(), HSNetworkHostNameIsValid(), HSNetworkHostNameLogicalToDisplay(), HSNetworkHostNameLogicalToOdbc(), HSNetworkHostNameNormalize(), HSNetworkHostNameSet()
property HSTLSActive as %Boolean [ Required ];
Whether SSL/TLS is active as selected in the "Installer Wizard".
Property methods: HSTLSActiveDisplayToLogical(), HSTLSActiveGet(), HSTLSActiveIsValid(), HSTLSActiveLogicalToDisplay(), HSTLSActiveNormalize(), HSTLSActiveSet()
property HSTLSConfig as HS.HC.DataType.TLSConfigName;
IRIS SSL/TLS Configuration for the instance as selected in the "Installer Wizard".
Property methods: HSTLSConfigDisplayToLogical(), HSTLSConfigGet(), HSTLSConfigIsValid(), HSTLSConfigLogicalToDisplay(), HSTLSConfigLogicalToOdbc(), HSTLSConfigNormalize(), HSTLSConfigSet()
property HSTLSPort as %Integer;
SSL/TLS Port as selected in the "Installer Wizard".
Property methods: HSTLSPortDisplayToLogical(), HSTLSPortGet(), HSTLSPortIsValid(), HSTLSPortLogicalToDisplay(), HSTLSPortNormalize(), HSTLSPortSet(), HSTLSPortXSDToLogical()
property HSTLSWebServerPrefix as HS.HC.DataType.WebServerPrefix;
SSL/TLS Webserver Prefix as selected in the "Installer Wizard".
Property methods: HSTLSWebServerPrefixDisplayToLogical(), HSTLSWebServerPrefixGet(), HSTLSWebServerPrefixIsValid(), HSTLSWebServerPrefixLogicalToDisplay(), HSTLSWebServerPrefixLogicalToOdbc(), HSTLSWebServerPrefixNormalize(), HSTLSWebServerPrefixSet()
property HSVersionString as %String) [ Required ];
Full HS version string as displayed in the "About" page.
Property methods: HSVersionStringDisplayToLogical(), HSVersionStringGet(), HSVersionStringIsValid(), HSVersionStringLogicalToDisplay(), HSVersionStringLogicalToOdbc(), HSVersionStringNormalize(), HSVersionStringSet()
property InstanceName as HS.HC.DataType.InstanceName [ Required ];
Name of this instance.
Property methods: InstanceNameDisplayToLogical(), InstanceNameGet(), InstanceNameIsValid(), InstanceNameLogicalToDisplay(), InstanceNameLogicalToOdbc(), InstanceNameNormalize(), InstanceNameSet()
property IsMirrorEnabled as %Boolean [ Required ];
Whether this instance is mirror enabled.
Property methods: IsMirrorEnabledDisplayToLogical(), IsMirrorEnabledGet(), IsMirrorEnabledIsValid(), IsMirrorEnabledLogicalToDisplay(), IsMirrorEnabledNormalize(), IsMirrorEnabledSet()
Mirroring-specific info for the instance.
Property methods: MirrorInfoGet(), MirrorInfoGetSwizzled(), MirrorInfoIsValid(), MirrorInfoNewObject(), MirrorInfoSet()
property RunningSince as %TimeStamp [ Required ];
Time since instance has been running.
Property methods: RunningSinceDisplayToLogical(), RunningSinceGet(), RunningSinceIsValid(), RunningSinceLogicalToDisplay(), RunningSinceLogicalToXSD(), RunningSinceNormalize(), RunningSinceOdbcToLogical(), RunningSinceSet(), RunningSinceXSDToLogical()
property SecureManagementPortalUrl as %String);
URL to the management portal (TLS enabled).
Property methods: SecureManagementPortalUrlDisplayToLogical(), SecureManagementPortalUrlGet(), SecureManagementPortalUrlIsValid(), SecureManagementPortalUrlLogicalToDisplay(), SecureManagementPortalUrlLogicalToOdbc(), SecureManagementPortalUrlNormalize(), SecureManagementPortalUrlSet()
property SuperServerPort as %Integer [ Required ];
Superserver port for the instance.
Property methods: SuperServerPortDisplayToLogical(), SuperServerPortGet(), SuperServerPortIsValid(), SuperServerPortLogicalToDisplay(), SuperServerPortNormalize(), SuperServerPortSet(), SuperServerPortXSDToLogical()
property WebServerPort as %Integer [ Required ];
Webserver port for the instance.
Property methods: WebServerPortDisplayToLogical(), WebServerPortGet(), WebServerPortIsValid(), WebServerPortLogicalToDisplay(), WebServerPortNormalize(), WebServerPortSet(), WebServerPortXSDToLogical()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab