Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

SYS.EManager

class SYS.EManager extends %Library.RegisteredObject

This class provides a set of public APIs for an Instance managed by the Enterprise Manager.

Method Inventory

Methods

classmethod GetPolicy(ManagerAddress As %List, ByRef Certificate As %String) as %String
Returns "SSL", "WS-Security", or "None" to indicate security setting of EM, and the Certificate values as an array. This step is optional if the user knows the security setting and doesn't want to check the certificate. Might also return "Error: error message" if there's a problem.
classmethod RequestRegistration(ManagerAddress As %List, InstanceAddress As %List, InstanceDescription As %String, SecurityName As %String) as %String
Request registration with Enterprise Manager for this Instance.
The 'Address' arguments are three element $List structures with a HostName (or IP address), Port and an optional Prefix (for hosted CSP connections).
'SecurityName' is either an SSL/TLS configuration name or an X.509 credentials alias (or null). The user is responsible for creating these using the UI or Security class APIs.
Will return null "" on success or an error string if there's a problem.
classmethod Status() as %String
Contacts the Enterprise Manager to get the current status of the Instance and check the connection. Returned value may be 'NotManaged', 'NoAnswer','AwaitingAcceptance', 'Managed','Suspended', 'NotUpdated','RejectedForManagement', or 'RemovedFromManagement'. Caller should handle any unknown status code to accomodate future versions.
classmethod SuspendManagement(Output Error As %String) as %Boolean
Suspend management of this Instance. Returns 1 (success) or 0 (fail). 'Error' may contain a text error message if this fails for some reason.

Note that this is primarily for use in emergency situations where CSP has been disabled accidentally, and it's not possible to use the Management Portal or the Enterprise Manager (which both depend on CSP) to Suspend management. The Instance will be Suspended and local management enabled, regardless of whether we can contact the Enterprise Manager.
classmethod UpdateEnabled(ServiceName As %String, Enabled As %Boolean) as %Boolean
Allows an application to control whether a managed Instance will accept updates from the Enterprise Manager for a specific Service, and helps manage user access to the system. Returns the current state as a %Boolean value. The default is for updates to all Services to be enabled. This requires %Admin_Secure and %Admin_Manage privileges to change 'Enabled'.

No 'Enabled' argument just returns current status for a Service.

This setting will be remembered even if the Instance is not managed for a Service or is removed from management.

Note that future versions of Enterprise Manager and Cache should provide features (such as run-levels or full synchronization of updates between Instances) that make this unnecessary. But this is provided as an interim step to facilitate application controlled updates.
classmethod UpdateInProgress(Output LastUpdateComplete As %TimeStamp) as %Boolean
Indicates that an Enterprise Manager update is in progress. Can be checked to see when it's safe to enable user access. Also returns date/time for last update completed.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab