GatewayMgr Class Reference

The Gateway Manager class defines an API used to control a Gateway from ObjectScript code. More...

Public Member Functions
_.Library.Status	ActivateCSPIni ()
	<method>ActivateCSPIni</method> activates changes made manually to the Gateway Configuration (CSP.ini) More...
_.Library.Status	ClearCSPLog ()
	<method>ClearCSPLog</method> clears the Event Log (CSP.log) More...
_.Library.Status	ClearCache (_.Library.List clearFilenames)
	<method>ClearCache</method> clears the Gateway's Page Cache. More...
_.Library.Status	CloseConnections (_.Library.String connections)
	<method>CloseConnection</method> closes connections to this gateway. More...
_.Library.Status	GetApplicationParams (_.Library.String path, configAry)
	<method>GetApplicationParams</method> gets the Application Access Parameters. More...
_.Library.Status	GetApplicationPaths (_.Library.List appPaths)
	<method>GetApplicationPaths</method> gets the list of configured application paths for this Gateway. More...
_.Library.Status	GetCSPIni (cspIni, _.Library.String format)
	<method>GetCSPIni</method> get the contents of the configuration file (CSP.ini). More...
_.Library.Status	GetCSPLog (_.Stream.GlobalCharacter cspLogStream, _.Library.String startDateTime, _.Library.Integer direction, nEvents)
	<method>GetCSPLog</method> gets the Event Log (CSP.log) More...
_.Library.Status	GetDefaultParams (configAry)
	<method>GetDefaultParams</method> gets Default Parameters. More...
_.Library.Status	GetInfo (info, _.Library.String format)
	<method>GetInfo</method> gets the information about the gateway. More...
_.Library.Status	GetServerParams (_.Library.String server, configAry)
	<method>GetServerParams</method> gets the Server Access Parameters for this server. More...
_.Library.Status	GetServerStatus (_.Library.String path, _.Library.String server, statusAry)
_.Library.Status	GetServers (_.Library.List serverList)
	<method>GetServers</method> gets the list of configured servers for this server. More...
_.Library.Status	GetSystemMetrics (metricsAry)
	<method>GetSystemMetrics</method> gets information related to Gateway performance. More...
_.Library.Status	GetSystemStatus (systemStatus, _.Library.String format)
_.Library.Status	GetThisServerName (serversAry)
	<method>GetThisServerName</method> gets the name that the Gateway uses to access this InterSystems IRIS server. More...
_.Library.Status	SetApplicationParams (_.Library.String path, configUpdates)
	<method>SetApplicationParams</method> updates settings in the 'Application Access' section. More...
_.Library.Status	SetDefaultParams (configUpdates)
	<method>SetDefaultParams</method> updates parameters in the 'Default Parameters' section. More...
_.Library.Status	SetServerParams (_.Library.String server, configUpdates)
	<method>SetServerParams</method> updates settings in the 'Server Access' section. More...
_.Library.Status	SetServerStatus (_.Library.String path, _.Library.String server, _.Library.Integer status)

Public Attributes
	AppMatch
	The URL part matching the Web Application that initialized this connection. More...
	CachePid
	The process identifier associated with this connection. More...
	IPAddress
	More...
	LastConnectTime
	More...
	Port
	More...
	ResponseBufferTimeout
	the Gateway. The response is sent in buffers. This is the maximum time the Manager will wait for the next buffer to be send, including the first buffer, i.e., the response must begin within ResponseBufferTimeout seconds of the request. This is measured in seconds. The default value is 10 seconds.  More...
	Server
	More...
	State
	Version
	More...

Detailed Description

The Gateway Manager class defines an API used to control a Gateway from ObjectScript code.

These provide the infrastructure for accessing (and modifying) the Gateway's internal tables, configuration, and log files from participating servers. This functionality is only provided by Version 2012 Gateways and later.

Participating InterSystems IRIS servers are those to which the Gateway holds at least one connection. The Gateway will not allow access to these facilities from any other client. This does mean, however, that ObjectScript routines cannot access Gateway resources until the Gateway has created its first connection to that server - even if the Gateway contains a configuration (under 'Server Access') for accessing that InterSystems IRIS server.

<script type="text/javascript" language="JavaScript">
function draw_a(){ var a_canvas = document.getElementById("gcanvas"); var ctx = a_canvas.getContext("2d"); ctx.beginPath(); ctx.fillStyle = 'rgb(64,64,128)'; var x = 10; var y0 = 10; var w = 150; var h = 26; var xoff=10; var yoff=15; var dy=70; var gap=15; ctx.strokeRect(x,y0,w+80,h); ctx.fillText("$System.CSP.GetGatewayRegistry()",x+xoff,y0+yoff); y1 = y0+dy; ctx.strokeRect(x,y1,w+80,h); ctx.fillText("%CSP.Mgr.GatewayRegisty.GetGatewayMgrs()",x+xoff,y1+yoff); y2 = y1+dy; x = 10; ctx.strokeRect(x,y2,w,h); ctx.fillText("%CSP.Mgr.GatewayMgr",x+xoff,y2+yoff); x = x+w+gap; ctx.strokeRect(x,y2,w,h); ctx.fillText("%CSP.Mgr.GatewayMgr",x+xoff,y2+yoff); x = x+w+gap; ctx.strokeRect(x,y2,w,h); ctx.fillText("%CSP.Mgr.GatewayMgr",x+xoff,y2+yoff); x = 30; y = y0+h; ctx.moveTo(x,y); ctx.lineTo(x,y1); y = y1+h; ctx.moveTo(x,y); ctx.lineTo(x,y2); y = y2 - (h/3); ctx.moveTo(x,y); ctx.lineTo(x+(2*(w+gap)),y); ctx.lineTo(x+(2*(w+gap)),y2); ctx.moveTo(x+w+gap,y); ctx.lineTo(x+w+gap,y2); ctx.stroke(); ctx.restore(); } </script>

<canvas id="gcanvas" width="660" height="200">Please use a browser which supports html5.</canvas>

<script language="javascript"> function toggle() { var ele = document.getElementById("gatewayinfo"); var text = document.getElementById("displayText"); if(ele.style.display == "block") { ele.style.display = "none"; text.innerHTML = "How do I get a gateway?"; } else { ele.style.display = "block"; text.innerHTML = "hide"; } } </script> <script language="javascript"> function togglessxml() { var ele = document.getElementById("ssxmlExample"); var text = document.getElementById("displaySSXml"); if(ele.style.display == "block") { ele.style.display = "none"; text.innerHTML = "System Status XML Example"; } else { ele.style.display = "block"; text.innerHTML = "hide"; } } </script>

Security

For read-oriented methods (e.g. GetDefaultParams()), users must hold the Admin_Operate:Use or Admin_Manage:Use privilege.
For update-oriented methods (e.g. SetDefaultParams()), users must hold the Admin_Manage:Use privilege.

Logging

All Gateway Manager commands are recorded in the Event Log (Gateway Log Level 'v2'). For example a request for the configuration file would be logged as:

Gateway Management: CallBack Request for Information Command=sys_get_CSP_ini; Bytes Returned=4206; CSPSYS=sys_set_config:default&Server_Response_Timeout=300

A request to update the default configuration would be logged as something like:

Gateway Management: Response to CallBack: /csp/samples/CSP.Callback.cls HTTP/1.1 200 OK Content-Type= application/x-www-form-urlencoded Connection: close Content-Length: 83 CSPID: MyToken

Errors are recorded:

Gateway Management: Bad Request CSPrequest: xxx_yyy_CSP_log

Types of Methods

The methods are divided into two groups. Those that GET information from the Gateway and those that SEND information or action requests to the Gateway. These methods send asynchronous requests to the Gateway. To get a list of gateways see <class>CSP.Mgr.GatewayRegistry</class>.

GET

GET methods wait for ten seconds for the CSP infrastructure to process the request. A status of $$$OK indicates that the requested data was successfully returned The status of $$$GatewayRequestTimeoutSec indicates that the request timed out. The status will indicate that an error occurred in processing the request. These functions wait for the return data (up to 10 seconds). Generally, when the load on the server is not too heavy, they will return very quickly as the return a small amount of data. The exception is GetCSPLog() which can return a very large amount of data and potentially time out.

SEND

The status return indicates that the request was successfully sent to the Gateway. However, it does not indicate that updates were successfully applied. When a configuration is interactively modified, each parameter will be fully checked for validity. If a parameter or a value give for a particular parameter is unacceptable, then an error will be generated and the existing value is left unmodified. In some cases, the Gateway will modify a value such that it makes more sense in the context of the current configuration. For these cases a warning is generated with notification of the 'corrected' value. For commands updating configuration parameters, the new values should appear as a list of [name,value] pairs. For example: $lb("Server_Response_Timeout=90","Queued_Request_Timeout=70")

1. Note that all configuration parameters are case-sensitive.
2. All passwords will be encrypted (as appropriate) before they are saved in CSP.ini.

3. Setting a parameter to empty string ("") effectively deletes it from CSP.ini.

4. In all cases the parameter names should be specified exactly as they appear in CSP.ini. The parameter values, in most cases, take the values as shown in the management form.

Example:

SYS>s Reg=$SYSTEM.CSP.GetGatewayRegistry()

SYS>s Mgrs=Reg.GetGatewayMgrs()

SYS>w Mgrs.Count() 1 SYS>s Mgr=Mgrs.GetAt(1) SYS>w Mgr.Port 57775 SYS>s Status=Mgr.GetCSPIni(.ini)

SYS>zw ini ini("[APP_PATH_INDEX]","/csp")="Enabled" ini("[LOCAL]")="" ini("[LOCAL]","Maximum_Session_Connections")=3 ini("[LOCAL]","Minimum_Server_Connections")=3 ini("[LOCAL]","TCP_Port")=56781 ini("[SYSTEM]","Configuration_Initialized")="Thu Oct 27 08:57:23 2011" ini("[SYSTEM]","Configuration_Initialized_Build")=1201.1264 ini("[SYSTEM]","Queued_Request_Timeout")=60 ini("[SYSTEM]","SM_Timeout")=300 ini("[SYSTEM]","Server_Response_Timeout")=60 ini("[SYSTEM]","sys_shm_inst")=1 ini("[SYSTEM]","sys_timestamp")=1336083061

Member Function Documentation

ActivateCSPIni()

_.Library.Status ActivateCSPIni

(

)

<method>ActivateCSPIni</method> activates changes made manually to the Gateway Configuration (CSP.ini)

Security: To call this method, you must hold the Admin_Manage:Use privilege.

ClearCSPLog()

_.Library.Status ClearCSPLog

(

)

<method>ClearCSPLog</method> clears the Event Log (CSP.log)

Security: To call this method, you must hold the Admin_Manage:Use privilege.

ClearCache()

_.Library.Status ClearCache

(

_.Library.List

clearFilenames

)

<method>ClearCache</method> clears the Gateway's Page Cache.

The values of clearFilenames determines the exact action of the method.

1. An empty or undefined value indicates that the entire cache should be cleared.
2. A list of the file names to be purged from the cache.
3. A file name may contain a wildcard, '*'.

       1.  Clear all forms named 'zenutils.js', regardless of path: */zenutils.js
       2.  Clear all forms from the '/csp/samples/images/' location: /csp/samples/images/*
       3.  Clear all forms whose path/name contains the '/Zen_' token: */Zen* 

Security: To call this method, you must hold the Admin_Manage:Use privilege.

CloseConnections()

_.Library.Status CloseConnections

(

_.Library.String

connections

)

<method>CloseConnection</method> closes connections to this gateway.

connections specifies which connections are to be closed:

ValueConnections Closed
*	All connections
Server Name	Close connections to a specific server, e.g. LOCAL
number	Close a specific connections, e.g. 3
list of numbers	Close a list of specific connections, e.g, $lb(2,5,7)

Security: To call this method, you must hold the Admin_Manage:Use privilege.

GetApplicationParams()

_.Library.Status GetApplicationParams	(	_.Library.String	path,
			configAry
	)

<method>GetApplicationParams</method> gets the Application Access Parameters.

path indicates the application path whose parameters are being requested. See the <method>GetApplicationPaths</method>() method to obtain a list of the application paths defined for this Gateway.

configAry [name,value] pairs are returned in local array

See <method>SetApplicationParams</method> for a list of parameters.

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetApplicationPaths()

_.Library.Status GetApplicationPaths

(

_.Library.List

appPaths

)

<method>GetApplicationPaths</method> gets the list of configured application paths for this Gateway.

appPaths is a list of strings, each an application path.

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetCSPIni()

_.Library.Status GetCSPIni	(		cspIni,
		_.Library.String	format
	)

<method>GetCSPIni</method> get the contents of the configuration file (CSP.ini).

format is the return format:
"array" - return as an array.
"stream" - returns as a <class>Stream.GlobalCharacter</class>.

cspIni

If format="array", tke values are returned in a two-level array. A partial example:

cspini("[APP_PATH:/]", "Default_Server" ) = "LOCAL" cspini("[APP_PATH:/csp]", "Default_Server") = "LOCAL" cspini("[APP_PATH:/csp]", "GZIP_Minimum_File_Size") = "0" cspini("[LOCAL]", "Ip_Address") = "127.0.0.1" cspini("[LOCAL]", "Maximum_Server_Connections") = "4" cspini("[LOCAL]", "Maximum_Session_Connections") = "3" cspini("[LOCAL]", "Minimum_Server_Connections") = "30" cspini("[LOCAL]", "Username") = "CSPSystem"

If format="stream", the data is returend as a <class>Stream.GlobalCharacter</class> object which allows the CSP Ini text to be parsed directly.

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetCSPLog()

_.Library.Status GetCSPLog	(	_.Stream.GlobalCharacter	cspLogStream,
		_.Library.String	startDateTime,
		_.Library.Integer	direction,
			nEvents
	)

<method>GetCSPLog</method> gets the Event Log (CSP.log)

cspLogStream is a <class>Stream.GlobalCharacter</class> stream from which you can read the lines of the returned from the event log
When you close the stream, the temporary data from the server will be removed.

startDateTime the time from which to start returning events. The format the date one of the following:

   C format: e.g.:         Fri Apr 01 22:28:23 2011 
      RFC1123 format: e.g.:   Mon, 26 Jul 2010 15:09:28 GMT

The value "now" [default] will be replaced by the current date and time.

direction the direction to scan for events: 1 -> forward; -1 -> backward

nEvents the number of Events to return from the event file. Each event consists of one line in a structured name-value pair format. Caution: The CSP Log file contains tens of thousands of lines of text. If you request too many events in one call, GetCSPLog() will timeout waiting for the Gateway to finish transfering all the data.

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetDefaultParams()

_.Library.Status GetDefaultParams

(

configAry

)

<method>GetDefaultParams</method> gets Default Parameters.

config values are returned as named parameters of the object. See <method>SetDefaultParams</method> for a list of parameters.

configAry [name,value] pairs are returned in local array

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetInfo()

_.Library.Status GetInfo	(		info,
		_.Library.String	format
	)

<method>GetInfo</method> gets the information about the gateway.

format is the return format:
"object" - return as <class>CSP.Mgr.GatewayInformation</class> object;
"stream" - returns as the information as XML in a <class>Stream.GlobalCharacter</class>.

info if format="object" this is an instance of the <class>CSP.Mgr.GatewayInformation</class> class.
if format="stream", this is a <class>Stream.GlobalCharacter</class> containing the information as XML

<?xml version="1.0" encoding="UTF-8" ?> <GatewayInformation> <Version>2011.2.0.202.0</Version> <Build>1102.1226</Build> <WebServerName>localhost</WebServerName> <WebServerPort>57773</WebServerPort> <WebServerSoftware>Apache Cache_Server_Pages-Apache_Module/2011.2.0.202.0-1102.1226</WebServerSoftware> <ActiveInterface>apapi</ActiveInterface> </GatewayInformation>

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetServerParams()

_.Library.Status GetServerParams	(	_.Library.String	server,
			configAry
	)

<method>GetServerParams</method> gets the Server Access Parameters for this server.

server indicates that server path whose values are being requested. See the <method>GetServers</method>() method to obtain a list of the servers defined for this Gateway.

configAry [name,value] pairs are returned in local array

See <method>SetServerParams</method> for a list of parameters.

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetServerStatus()

_.Library.Status GetServerStatus	(	_.Library.String	path,
		_.Library.String	server,
			statusAry
	)

<method>GetServerStatus</method> retrieves the 'online' status for either a single or a specified range of InterSystems IRIS servers

path is the application path as defined in the Gateway Configuration (or "*" for all)
server is the InterSystems IRIS server name as defined in the Gateway configuration (or "*" for all)

An array of servers and their status is returned as follows:

statusAry(path,server_number)=$List(server, status)

Where status is '1' for online and '0' for offline

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetServers()

_.Library.Status GetServers

(

_.Library.List

serverList

)

<method>GetServers</method> gets the list of configured servers for this server.

serverList is a list of strings, each the name of a configured server.

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetSystemMetrics()

_.Library.Status GetSystemMetrics

(

metricsAry

)

<method>GetSystemMetrics</method> gets information related to Gateway performance.

The information returned is used by the Gateway Monitor.

metricsAry [name,value] pairs are returned in local array

Security: No privileges are necessary to call this method.

GetSystemStatus()

_.Library.Status GetSystemStatus	(		systemStatus,
		_.Library.String	format
	)

<method>GetSystemStatus</method> gets the System Status.

format is the return format:
"object" - return as an object;
"stream" - returns as the information as XML.

systemStatus if format="object" returned as an instance of a <class>CSP.Mgr.GatewaySystemStatus</class> object. There are the following main sections to the status: Connections, Servers, Application Paths, Alternative Servers, and Cached Form.
if format="stream", this is a Stream.GlobalCharacter containing the information as XML

Connection, number
	WebServerPID
	CacheServerName
	IpAddress
	TCPPort
	CacheServerPID
	Status
	IdleTime
	Activity
CacheServer, number
	CacheServerName
	IpAddress
	TCPPort
	TotalConnections
	ConnectionsInUse
	PrivateConnections
	Activity
	QueuedRequests
Application Path, path
	AlternativeServer
	CacheServerName
	Activity
	Status
Alternative Server, number
	CacheServerName
	Activity
	Status
CachedForms
	FormsInCache
	CachedData
	CacheActivity
CachedForms,Form, form name
	Size
	Activity

System Status XML Example

Example:

<?xml version="1.0" encoding="UTF-8" ?> <GatewaySystemStatus> <Connections> <Connection Number="0"> <WebServerPID>5936</WebServerPID> <CacheServerName>APPSERVER1</CacheServerName> <IpAddress>127.0.0.1</IpAddress> <TcpPort>56773</TcpPort> <CacheServerPID>3304</CacheServerPID> <Status>Free</Status> <IdleTime>0/0</IdleTime> <Activity>19</Activity> </Connection> <Connection Number="1"> <WebServerPID>5936</WebServerPID> <CacheServerName>APPSERVER1</CacheServerName> <IpAddress>127.0.0.1</IpAddress> <TcpPort>56773</TcpPort> <CacheServerPID>3428</CacheServerPID> <Status>Free</Status> <IdleTime>0/0</IdleTime> <Activity>12</Activity> </Connection> </Connections> <CacheServers> <CacheServer Number="2"> <CacheServerName>APPSERVER1</CacheServerName> <IpAddress>127.0.0.1</IpAddress> <TCPPort>56773</TCPPort> <TotalConnections>6</TotalConnections> <ConnectionsInUse>0</ConnectionsInUse> <PrivateConnections>0</PrivateConnections> <Activity>75</Activity> <QueuedRequests>0</QueuedRequests> </CacheServer> </CacheServers> <ApplicationPaths> <ApplicationPath Number="1"> <Path>/csp</Path> <AlternativeServer Number="0"> <CacheServerName>APPSERVER1</CacheServerName> <Activity>75</Activity> <Status>Enabled (Master)</Status> </AlternativeServer> <AlternativeServer Number="1"> <CacheServerName>APPSERVER2</CacheServerName> <Activity>0</Activity> <Status>Disabled</Status> </AlternativeServer> </ApplicationPath> </ApplicationPaths> <CachedForms> <FormsInCache>1</FormsInCache> <CachedData>6584</CachedData> <CacheActivity>3</CacheActivity> <Form id="/csp/samples/images/zenLogo.svg"> <Size>6584</Size> <Activity>3</Activity> </Form> </CachedForms> </GatewaySystemStatus>

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

GetThisServerName()

_.Library.Status GetThisServerName

(

serversAry

)

<method>GetThisServerName</method> gets the name that the Gateway uses to access this InterSystems IRIS server.

The Gateway can be configured to access the same InterSystems IRIS server via multiple names. Therefore a numbered array will be returned. Index zero will hold the name used to currently access this InterSystems IRIS server. Any other names will follow in the numbered list.

serversAry [number,name] pairs are returned in local array

Security: To call this method, you must hold the Admin_Operate:Use or Admin_Manage:Use privilege.

SetApplicationParams()

_.Library.Status SetApplicationParams	(	_.Library.String	path,
			configUpdates
	)

<method>SetApplicationParams</method> updates settings in the 'Application Access' section.

path indicates that application path being updated. See the <method>GetApplicationPaths</method>() method to obtain a list of the application paths defined for this Gateway.

configUpdates a local array whose [name,value] pairs are used to update the configuration.

Param Name	Description
Application_Status	Service Status: Enabled, Disabled
Extra_CGI_Env_Variables	Extra CGI Environment Variables
Proc_Class	Process with this class
GZIP_Compression	GZIP Compression: Enabled, Disabled
GZIP_Mininum_File_Size	GZIP minimum file size
GZIP_Exclude_File_Types	GZIP exclude file types
KeepAlive	Keep alive: Enabled, Disabled, No Action
Non_Parsed_Headers	Non-parsed headers: Enabled, Disabled
Default_Server	Default server
Alternative_Servers	Alternative Servers. This takes one of the following values: LoadBalancing - Load balancing and failover FailOver - Failover only Disabled - Disabled
Alternative_Server_[n]	Alternative server
Alternative_Server_[n]_Status	Alternative Server Status: Enabled, Disabled, OFFLINE

Security: To call this method, you must hold the Admin_Manage:Use privilege.

SetDefaultParams()

_.Library.Status SetDefaultParams

(

configUpdates

)

<method>SetDefaultParams</method> updates parameters in the 'Default Parameters' section.

configUpdates a local array whose [name,value] pairs are used to update the configuration.

Param Name	Description
Instance_Host_Name	Instance host name
SM_Forms	Access to these forms
Username	User name
Password	Password All passwords will be encrypted (as appropriate) before they are saved in CSP.ini.
SM_Timeout	Session Timeout
System_Manager	System Manager Machine(s)
System_Manager_UNPW_Override	Override Username and Password Checkbox "1"=checked; ""=unchecked
Server_Response_Timeout	Server response timeout
Queued_Request_Timeout	Queued request timeout
No_Activity_Timout	No activity timeout
Env_Parameters	Event Log Level
Event_Log_File	Event log file
Event_Log_Rotation_Size	Event log rotation size
Maximum_Logged_Request_Size	Maximum data logged per HTTP request
Document_Root	Web document root
ASP_Directory	Temp ASP Directory
WS_Service_Status	Service State: Enabled,Disabled
NSD_Document_Root	NSD Document Root
Server_Error	Server Error
Server_Busy	Server_Busy
Server_Unavailable	Server Unavailable
Server_Timeout	Server timeout
Connection_Closed	Connection closed

Security: To call this method, you must hold the Admin_Manage:Use privilege.

SetServerParams()

_.Library.Status SetServerParams	(	_.Library.String	server,
			configUpdates
	)

<method>SetServerParams</method> updates settings in the 'Server Access' section.

server indicates that server path being updated. See the <method>GetServers</method>() method to obtain a list of the servers configured on this Gateway.

configUpdates a local array whose [name,value] pairs are used to update the configuration.

Param Name	Description
Server_Status	Server status: Enabled, Disabled
Ip_Address	IP Address
TCP_Port	TCP Port
Minimum_Server_Connections	Minimum server connections
Maximum_Server_Connections	Maximum server connections
Connection_Security_Level	Connection Security Level This takes a numeric value: 0 Password 1 Kerberos 2 Kerberos with Packet Integrity 3 Kerboros with Encryption 10 SSL
Product	Product This takes a numeric value: 0 (deprecated) 1 InterSystems IRIS
Service_Principal_Name	Service principal name
Keytable	Key table
SSLCC_Protocol	SSL Protocol Deprecated; use SSLCC_Protocol_Min and SSLCC_Protocol_Max instead
SSLCC_Protocol_Min	Minimum SSL/TLS Protocol Version This takes a numeric value: 4 TLSv1.0 8 TLSv1.1 16 TLSv1.2 32 TLSv1.3
SSLCC_Protocol_Max	Maximum SSL/TLS Protocol Version This takes a numeric value: 4 TLSv1.0 8 TLSv1.1 16 TLSv1.2 32 TLSv1.3
SSLCC_Key_Type	SSL Key Type This takes a numeric value: 1 DSA 2 RSA
SSLCC_Verify_Peer	SSL Verify Peer checkbox: "1"=Checked;""=Unchecked"
SSLCC_Cipher_Suites	The Cipher Suite list (TLSv1.2 and below)
SSLCC_Cipher_Suites_1_3	The Cipher Suite list (TLSv1.3)
SSLCC_Certificate_File	SSL Certificate File
SSLCC_Certificate_Key_File	SSL Certifictate Key File
SSLCC_CA_Certificate_File	SSL CA Certificate File

Alternative Servers should be saved as a contiguous set of alternative servers as follows:

Alternative_Server_1=APPSERVER1 Alternative_Server_1_Status=Enabled Alternative_Server_2=APPSERVER2 Alternative_Server_2=Disabled

Security: To call this method, you must hold the Admin_Manage:Use privilege.

SetServerStatus()

_.Library.Status SetServerStatus	(	_.Library.String	path,
		_.Library.String	server,
		_.Library.Integer	status
	)

<method>SetServerStatus</method> sets the 'online' status for either a single or a specified range of InterSystems IRIS servers

path is the application path as defined in the Gateway Configuration (or "*" for all)
server is the InterSystems IRIS server name as defined in the Gateway configuration (or "*" for all)
status is '1' for online and '0' for offline

Security: To call this method, you must hold the Admin_Manage:Use privilege.

Member Data Documentation

AppMatch

AppMatch

The URL part matching the Web Application that initialized this connection.

 

CachePid

CachePid

The process identifier associated with this connection.

(Has a value only for Active connections.)

 

IPAddress

IPAddress

 

The Server and Port information of the Gateway being managed. This is used if connecting using the server name fails.

LastConnectTime

LastConnectTime

 

LastConnectTime contains the data/time of the last time this Gateway connected to this InterSystems IRIS instance

Port

Port

 

 

ResponseBufferTimeout

ResponseBufferTimeout

the Gateway. The response is sent in buffers. This is the maximum time the Manager will wait for the next buffer to be send, including the first buffer, i.e., the response must begin within ResponseBufferTimeout seconds of the request. This is measured in seconds. The default value is 10 seconds. 

ResponseBufferTimeout the maximum time the Mgr will before for the next portion of the response. 'GET's wait for a response from

Server

Server

 

The Server and Port information of the Gateway being managed. If connecting with the server name fails, the IP Address will be used instead.

State

State

State has one of the following values:

• "a" - This gateway has a live connection to the currently-running instance of InterSystems IRIS.
• "i" - This gateway was connected to this InterSystems IRIS instance some time in the recent past (currently one month), but is does not have a live connection to the currently-running InterSystems IRIS instance

 

Version

Version

 

The Version of the Gateway being managed.

.