JMS Queue Message Format Field Definitions
- Configuration manager primary configuration objects
- Engine heart beat status fields
- Adapters heart beat status fields
- Engine fields
- Adapter fields
- HTTP adapter specific fields
- CD adapter specific fields
- FTP adapter specific fields
- SFTP adapter specific fields
- Netmap fields
- Policy fields
- HTTP policy specific fields
- CD policy specific fields
- FTP and SFTP Policy specific fields
- EAServer fields
- Perimeter server fields
- Step injection fields
- PasswordPolicy fields
- UserStore fields
- KeyStore fields
- SSO configuration fields
- CMUser fields
- SYSGlobals fields
- ACCEPTER fields
- SysSsIInfo fields
- User fields
- KeyDef Fields
- Node Def fields
- Inbound Node Def specific fields
- outbound Node Def specific fields
- SSLInfo fields
- NodeAddress fields
- AdapterEngine fields
- JMS Config fields
- Base Object fields (extended by all primary objects)
| Field Name |
Description |
|---|---|
| Engine |
engine |
| CdAdapter |
cdAdapter |
| HttpAdapter |
httpAdapter |
FtpAdapter |
ftpAdapter |
SftpAdapter |
sftpAdapter |
PesitAdapter |
pesitAdapter |
CdNetmap |
cdNetmap |
HttpNetmap |
httpNetmap |
FtpNetmap |
ftpNetmap |
SftpNetmap |
sftpNetmap |
PesitNetmap |
pesitNetmap |
CdPolicy |
cdPolicy |
HttpPolicy |
httpPolicy |
FtpPolicy |
FtpPolicy |
SftpPolicy |
sftpPolicy |
PesitPolicy |
pesitPolicy |
ExternalAuthentication |
eaServer |
PerimeterServer |
perimeterServer |
Step Injection |
stepInjection |
PasswordPolicy |
passwordPolicy |
UserStore |
userStore |
KeyStore |
keyStore |
SSO |
ssoConfig |
CMUser |
haasUser |
SysGlobals |
sysGlobals |
Accepter |
accepter |
SysSslInfo |
sysSslInfo |
| Field Name |
Description |
|---|---|
| engineName |
Engine Name |
| versionId |
Current Engine configuration ID |
| cmVersionId |
Current CM Configuration Level |
status |
Status (running|stopped) |
message |
System message regarding this Engine |
dateStarted |
The date the engine was started |
dateLastUpdated |
The Date Engine Configuration was changed |
adapterStatuses |
List of adapters attached to this engine |
| Field Name |
Description |
|---|---|
| name |
Name of the adapter |
| dateStarted |
Date adapter was started |
| status |
Status (running|stopped|pending|warning|error) |
message |
System message regarding this adapter |
listenPort |
Adapter listen port |
protocol |
Protocol (http, ftp, sftp, cd, pesit) |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| adapters |
List of Adapters configured for engine |
|
| port |
Engine Listen Port |
Engine listen port is the port on which the engine listens for configuration information from Configuration Manager (CM). Valid values are 1–65535. |
| localBindAddress |
Local Bind Address |
localBindAddress for engine |
debugLogging |
Engine Logging Level |
Debug level for engine |
localPSLogging |
Local Perimeter Server Logging Level |
Level of logging to write to the local perimeter server log. Logging options include: |
certicomLogging |
Certicom Logging Level |
Certicom Logging Level identifies the level of logging to write to the certicom log. Logging options include: |
userStore |
User Store |
User Store identifies the user store to use with this engine. It is the location where users who access the engine are defined. defUserStore is the default user store. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| Type |
Type |
Type identifies the protocol being used. |
| serviceType |
Service Type |
Engine |
| group |
Group |
Not used |
netmap |
Netmap |
Netmap identifies the name of the netmap to associate with the adapter you are defining. If the netmap has not been created, click + to add the netmap |
netmapKey |
Netmap Key |
Select the Routing Type to identify how inbound connections are routed to the server in the trusted zone. Routing options include |
maxAuthAttempts |
Maximum Authentication attempts |
Certicom |
maxSessions |
Maximum Sessions |
Maximum Sessions identifies the maximum number of concurrent sessions that the adapter allows. Default=20. |
|
sessionTimeout |
Session Timeout |
Session Timeout identifies the amount of time allowed, in seconds, between transmissions of TCP packets before a session is terminated. Default =90 seconds. |
|
listenPort |
Listen Port |
Listen Port identifies the port number to use to listen for inbound connections. Valid values include 1-65535. |
|
listenAddr |
Listen |
Not Used |
|
standardRoute |
Standard Route |
SNODE Netmap Entry identifies the name of the Connect:Direct server where the node connections are routed, after connecting to Secure Proxy. Select this value from a pull-down list. |
|
internalUserId |
Not Used |
|
|
uri |
uri |
Not Used |
|
pingResponse |
Ping Response |
Http Ping Response identifies the response sent when an HTTP GET is received on the listen port. Provide this value to send a health check response to a third-party IP load balancer, such as Big IP. |
|
psOutPortrange |
Outbound Port Range |
Outbound Port Range identifies the range of ports to use for the adapter. Valid values include a list of ports that are allowed with each value separated by a comma such as 1234, 2340, 16570 or a range of ports allowed, such as 16570 -17950. |
|
protocol |
Protocol |
Hidden |
|
logLevel |
Logging Level |
Logging Level identifies the level of logging to write to the log file for the adapter. Logging options include: |
|
ssoConfig |
SSO Config |
|
|
engines |
Engine |
Engine identifies the Secure Proxy server in the DMZ where traffic is first routed before being sent to the outbound Secure Proxy server. Select an engine from the list. You must define an engine before you can create an adapter. |
|
properties |
Properties |
Properties associated with how the Secure Proxy protocol is implemented. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| htmlUrlRewrite |
Html URL Rewrite |
Enable Support HTML Rewrite to rewrite URLs within the HTML returned by the outbound node. HTML Rewrite must also be defined and enabled on the netmap. |
| urlRoutingType |
Url Routing Type |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| urlRoutingType |
Url Routing Type |
Not Used |
| encryptionLevel |
Encryption Level |
Inbound and outbound sessions can have different levels of encryption |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| portRange |
Port Range |
Outbound Port Range identifies the range of ports to use for the adapter. Valid values include a list of ports that are allowed with each value separated by a comma such as 1234, 2340, 16570 or a range of ports allowed, such as 16570 -17950. |
| natAddress |
Passive NAT Address |
Passive NAT Address identifies the IP address sent to the FTP client in response to a PASV command. Define this value if the client cannot directly connect to the proxy, such as when using a remote perimeter server or static network address translation (NAT). The default value is the remote perimeter server address. |
| passivePortRange |
Passive Port Range |
Passive Data Listening Port Range identifies the port range used to listen for connections on the data channel when the client issues a PASV command. If no value is specified, any available port is used. |
activePortRange |
Active Port Range |
Active Data Outbound Port Range identifies the port range to use to listen for connections on the client data channel, when the client submits a PORT command. If no value is specified, any available port is used. |
usePasvIP |
Use IP from passive Response |
Enable this option to use the IP address from the PASV response for outbound data connections. Otherwise, the IP address in the PASV response is ignored and the connection is made to the same IP Address as the initial command connection. |
serverGreetingBannerText |
Server Greeting Banner Text |
Text to display when a user successfully connects to the server. For example, type Welcome to my ftp site. If no text is provided in this field, the default banner, 220 FTP Server ready, is displayed. Valid values are 0-4000 alphanumeric characters |
loginBannerText |
Login Banner Text |
Identify the text to display as a login message for an FTP proxy adapter. If no banner text is provided, the default banner, 230 User %user logged in, is displayed. Valid values are 0-4000 alphanumeric characters. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| serviceHostKey |
Service Host Key |
|
| compression |
Compression |
Compression method to use to compact files before they are transmitted and is negotiated with the client. Compression methods include none or Zlib. The default is none. If you make changes to the compression value, you must restart the adapter before the change is recognized. If you select Zlib, both Zlib and None are supported. |
| macString |
MAC String |
Selected MAC Suites identifies the MACs you have enabled to provide message integrity protection. MACs are negotiated based on their location in the Selected MAC Suites list. To reorder a MAC in the list, highlight the MAC to reorder and click the Up or Down button. If you make changes to the selected MAC suites, you must restart the adapter before the change is recognized. |
keyExchangeString |
Key Exchange String |
Identifies the key exchanges that have been configured. Key exchanges are used in the order in which they are selected in this field. |
banner |
Banner |
Text displayed prior to client authentication when an inbound connection is made. It is sent to the client after server authentication is performed, but before the client is prompted for a password. Valid values are 0-4000 alphanumeric and special characters. No default value is defined. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| Protocol |
Protocol |
Protocol being used: HTTP, FTP, SFTP, or Connect:Direct. |
| inboundNodes |
List of InboundNodeDef |
|
| outboundNodes |
List of OutboundNodeDef |
|
urlRewriteConfig |
URL Rewrite |
|
urlRoutingConfig |
URL Routing |
|
outboundACLRequired |
Out Bound ACL Required |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| protocolValidationOn |
Protocol Validation On |
|
| eaCertValidation |
External Authentication Certificate Validation |
Enable Certificate Validation through External Authentication Server |
| userAuthentication |
User Authentication |
Enable the Authentication of Trading Partners through External Authentication |
internalUserId |
Internal User ID |
|
eaCertProfile |
External Authentication Certificate Profile |
External Authentication Certificate Profile identifies the name of the certificate validation definition you defined in the Sterling External Authentication Server. You must enable certificate validation before you can provide a profile. |
eaAuthProfile |
External Authentication Profile |
If you enabled user authentication through Sterling External Authentication Server, identify the certificate authentication profile you defined in Sterling External Authentication Server. |
userMapping |
User Mapping |
User ID and password used to attach to the server in the secure environment. For the user ID and password presented to the Sterling B2B Integrator server to successfully access the server, a user definition must be defined at the Sterling B2B Integrator server. User mapping options include: |
protocol |
Protocol |
Protocol |
authenticationType |
Authentication Type |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| blockCommonExploits |
Block Common Exploits |
Enable this option to scan inbound URI queries for any of the defined strings. If a match is found, the request is rejected and the connection is closed. Default blocked strings include: --, |, ', \, <?, \u0000. To modify the common exploits that are blocked, modify the strings. |
| commonExploitStrings |
Common Exploit String |
Exploit Patterns to prevent |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| blockCommonExploits |
Block Common Exploits |
Enable this option to scan inbound URI queries for any of the defined strings. If a match is found, the request is rejected and the connection is closed. Default blocked strings include: --, |, ', \, <?, \u0000. To modify the common exploits that are blocked, modify the strings. |
| protocolErrorAction |
Protocol Error Action |
Protocol Error Action identifies the action to perform if Secure Proxy detects protocol violations during a communications session. |
| runJobStepAllowed |
Run Job Step Allowed |
Allows runjob steps to be performed on the PNODE. |
runTaskStepAllowed |
Run Task Step Allowed |
Allows runtask steps to be performed on the PNODE. |
submitStepAllowed |
Submit Step Allowed |
Submit Step Allowed |
copyStepAllowed |
Copy Step Allowed |
Allows copy steps to be performed on the PNODE. |
ipAddressCheck |
IP Address Check |
Turn on Check IP Address to ensure that the IP address of the system connecting to the Connect:Direct adapter matches the address of that node in the netmap. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| eaKeyAuthProfile |
External Authentication Key Profile |
If you enabled user authentication through Sterling External Authentication Server, identify the certificate authentication profile you defined in Sterling External Authentication Server. |
| preferredAuthentication |
Preferred Authentication |
Required Authentication Methods identifies the method to use to authenticate the inbound node connection. Valid values include: |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| serverAddress |
External Authentication Server Name |
IP address or host name to use to connect to the Sterling External Authentication Server. Valid values are 1-200 alphanumeric characters with no spaces. Special characters allowed are period (.), dash (-), colon (:), and underscore (_). |
| serverPort |
External Authentication Server Port |
Port number to use to connect to the Sterling External Authentication Server. Valid values include 1-65535. |
| psName |
Not used |
|
outboundPortRange |
Outbound Port Range |
Range of ports to use to connect to the Sterling External Authentication Server. Valid values include a list of ports that are allowed with each value separated by a comma such as 1234, 2340, 16570 or a range of ports allowed, such as 16570 -17950. |
secureConnection |
Use Secure Connection |
Enable Use Secure Connection to turn on the use of SSL/TLS to provide secure communications with transport protocols and to ensure that data is secured as it is transmitted across a single socket. |
sslInfo |
Security Settings |
See SSLInfo for expansion |
addresses |
Alternate External Authentication Server |
Sterling External Authentication Server name to use to connect to an alternate Sterling External Authentication Server, if a connection to the primary Sterling External Authentication Server cannot be made. Up to three alternate servers can be defined for each Sterling External Authentication Server. The servers are used in sequence 1, 2, 3. See NodeAddress for list. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
| listenPort |
Proxy Local Interface |
Port number that the DMZ perimeter server monitors for connections. This is the port number you specified when installing your perimeter server in the DMZ. |
| listenSocket |
||
| outboundSocket |
||
portRange |
Port Range |
|
psHost |
Perimeter Server Host |
DNS name or TCP/IP address where the DMZ perimeter server is installed. |
psOutboundLowWaterMark |
Perimeter Server Outbound Low Water Mark |
Lowest outbound connection buffer size. This is the low water mark. The default is 150 KB. |
psOutboundHighWaterMark |
Perimeter Server Outbound High Water Mark |
Highest outbound connection buffer size. This is the high water mark. The default is 250 KB. |
psInboundLowWaterMark |
Perimeter Server Inbound Low Water Mark |
Lowest inbound connection buffer size. This is the low watermark. The default is 150 KB. |
psInboundHighWaterMark |
Perimeter Server Inbound High Water Mark |
Highest inbound connection buffer size. This is the high watermark. The default is 250 KB. |
reverseConnect |
Reverse Connect |
Place where DNS resolution occurs. The default is At Local Host. |
localHost |
Local Host |
Network interface Secure Proxy uses to connect to the perimeter server. The default is *, which allows the operating system to make the selection. You can specify any IP address or DNS name of an interface which exists on this machine. |
localPort |
Local Port |
Port number to use for the local end of the socket to the perimeter server. The default is 0, which allows the operating system to select any free port. Valid values are 1–65,535. |
type |
Type |
Perimeter Server Type |
dnsResolution |
dnsResolution |
Place where DNS resolution occurs. The default is At Local Host. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
copyOnSuccess |
Copy On Success |
Enable Copy on success to copy information to the SNODE at the end of a successful step. Information that can be copied includes certificate information, metadata returned by Secure External Authentication Server associated with the entity represented by the certificate, and Process information such as a file name or step name |
copyOnSuccessIdentifyingInformation |
Copy On Success Identifying Information |
If you enable Copy on success, identify what information to copy to the SNODE. |
copyOnSuccessSessionInformationOutputFile |
Copy On Success Session Information OutputFile |
Session information output file identifies the name of the file where information about the successful session is written. |
copyOnSuccessTimeout |
Copy On Success Timeout |
TCP timeout for copy identifies the number of seconds to wait for a TCP/IP request or response before ending the session |
copyOnFailure |
Copy On Failure |
Enable this option to copy session-specific data to the SNODE at the end of a failed step. |
copyOnFailureIdentifyingInformation |
Copy On Failure Identifying Information |
If you enable Copy on failure, identify the information to copy to the SNODE. |
copyOnFailureSessionInformationOutputFile |
Copy On Failure SessionIn formation OutputFile |
Session information output file identifies the name of the file where information about the failed session is to be written. |
copyOnFailureTimeout |
Copy On Failure Timeout |
TCP timeout for copy identifies the number of seconds to wait for a TCP/IP request or response before ending the session. |
executeOnSuccess |
Execute on Success |
Enable this option to execute an operating system command, program, or Submit Connect:Direct Process on the SNODE at the end of a successful step. |
executeOnSuccessIdentifyingInformation |
Execute On Success Indentifying Information |
|
executeOnSuccessStepParameters |
Execute On Success Step Parameters |
|
executeOnSuccessTimeout |
Execute On Success Timeout |
|
executeOnFailure |
Execute On Failure |
Enable Execute on failure to execute an operating system command, program, or Submit Connect:Direct Process on the SNODE at the end of a failed step. |
executeOnFailureIdentifyingInformation |
Execute On Failure Identifying Information |
Enable Execute on failure to execute an operating system command, program, or Submit Connect:Direct Process on the SNODE at the end of a failed step |
executeOnFailureStepParameters |
Execute On Failure Step Parameters |
Step parameter provides a place to type the step parameters. Refer to the Connect:Direct process Guide for information on step parameters. |
executeOnFailureTimeout |
Execute On Failure Timeout |
Enable Execute on failure to execute an operating system command, program, or Submit Connect:Direct Process on the SNODE at the end of a failed step. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
policyId |
Policy Id |
|
daysValid |
Days Valid |
Number of days that a user password is valid. The user is prompted to change the password when this time period expires. The default is 0,which means the password never expires. You can change this numberto any number you want. There is no maximum value. The expiration count down starts the first time a user logs in to Secure Proxy after a password is assigned to the user account. |
minimumLength |
Minimum Length |
Minimum length that the password must be. This field is required. Valid values are any numerals. The default value is 6. If no policy is applied, Secure Proxy enforces a minimum length of 6. |
maximumLength |
Maximum Length |
How long the password can be.This field is required. Valid values are any numerals. This number must be set to at least the same number as the minimum length. The default value is 28 |
keptInHistory |
Kept In Histor |
How many passwords to keep in the PWD_HISTORY table in the file for a user. Values store in history cannot be used when defining a new password value. |
mustContainSpecialCharacters |
Must Contain Special Characters |
The password must contain at least one special character, such as numeral, capital letter, !, @, #, $, %, ^, &, or *. |
requiresChange |
Requires Change |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
maxAuthAttempts |
Maximum Authentication Attempts |
|
accountUnlockDelay |
Account Unlock Delay |
User Lockout Duration identifies how long a user is unable to access Secure Proxy, after too many incorrect logon attempts. The default value is 300 seconds. |
type |
Type |
See UserDef for element expansion |
elements |
Users |
|
properties |
Properties |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
type |
Type |
|
elements |
Key Definitions |
See KeyDef for element expansion |
properties |
Properties |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
properties |
Properties |
|
ssoTokenCookieName |
SSO Token Cookie Name |
Cookie name used by Secure Proxy when communicating with the client. If an external authentication SSO server is used, this name must match the cookie name used by the external SSO authentication server. |
ssoBackendUserHeaderName |
SSO Backend User Header Name |
HTTP header used to send the user ID to the Sterling File Gateway server application. Default = SM_USER. |
ssoBackendTokenCookieName |
SSO backend Token Cookie Name |
Cookie name used to send the token to Sterling File Gateway or the application defined in the outbound node. The default is the same as the name of the front-end cookie name. |
applicationLoginPage |
Name of the page that is displayed when a trading partner logs in and single sign-on is configured. Default is login.html. |
|
applicationWelcomePage |
Application Welcome |
Name of the page that is displayed after a trading partner logs in. Default is welcome.html |
applicationChangepwPage |
Application Change Password Page |
Name of the page that is used to change a trading partner’s Password. Default is changepw.html. |
applicationLogoutPage |
Application Logout Page |
Name of the page that is displayed when a trading partner logs out. Default is logout.html. |
loginDirectoryId |
Login Directory ID |
Directory where the HTML files are stored. This directory is created below the installation directory. Default is Signon |
applicationLoginUrl |
Application Login Url |
|
loginPageCharSet |
Login Page Charset |
Character encoding sent as part of the content-type header to the browser with the login page. Default is UTF-8. |
loginPageMediaType |
Login Page Media Type |
Media type value sent to the browser in the content-type header with the login page. Default is text/html. |
ssoCookieDomain |
SSO Cookie Domain |
Domain that the trading partner connects to. The browser sends the cookie with requests which match this domain. If more than one server need to share this cookie, enter the domain that is common to these servers. |
ssoFQDN |
SSO FQDN |
External-facing or client-facing fully qualified DNS name the trading partner connects to. |
ssoPortalType |
SSO Portal Type |
|
defApplicationUrl |
Default Application Url |
Defines the server application URL. To support the myFilegateway application, set this field to myfilegateway. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
role |
User Role |
Role allowed by the user you create. The Operator role has read-only access to CM; whereas, the Admin role has full access to create and edit all of the configuration options available in CM. Admin is the default user role value. |
password |
Password |
Password required by the user to access CM. Up to 255 alphanumeric characters and does not allow comma (,), double quotes (“), or single quotes (‘). |
passwordPolicyId |
Password Policy Id |
Password policy to associate with the user you configure. Configure a password policy before you can associate it with a user. Select a Password Policy ID from the pull-down list. |
algorithm |
Algorithm |
Not Used |
properties |
Properties |
User Properties |
hashedName |
Hidden |
|
authProfile |
Authentication Profile |
External Authentication Server Profile |
eaServerName |
Ea Server Name |
External Authentication Server Configuration Name |
userAuthentication |
User Authentication |
|
loginLockoutTimestamp |
Login Lockout Timestamp |
Login Lockout Timestamp |
loginAttempts |
Login Attempts |
User Login Attempts |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
logLevel |
Logging Level |
Level of logging to write to the log file for CM. Logging options include: |
threadCount |
Thread Count |
|
minSvcPoolThreads |
||
maxSvcPoolThreads |
||
minReqPoolThreads |
||
maxReqPoolThreads |
||
listenBacklog |
Listen Backlog |
Number of client connections allowed in a queue before connections are refused. Valid values range from 0 to 999. |
acceptTimeout |
Accepter Timeout |
Number of seconds that the accepter listens before a timeout occurs. The default is 30. Valid values range from 0 to 9999. |
connectTimeout |
Connect Timeout |
How many seconds are allowed for an outbound connection from the server before a timeout occurs, if the connection is not accepted. Valid values range from 0 to 9999. |
clientReadTimeout |
Client Read Timeout |
How many seconds elapse before a read operation times out, if unsuccessful. Valid values range from 0 to 9999. |
SSLHandshakeTimeout |
SSL Handshake Timeout |
How many seconds are allowed for an SSL handshake. If the SSL handshake does not occur during this time, the session is terminated. This parameter ensures that a connecting client authenticates within a fixed amount of time. The default is 30 seconds. Valid values range from 0 to 9999. |
loginLockoutDelayTime |
Login Lockout Delay Time |
Amount of time to delay a locked out user |
maxAllowedLoginAttempts |
Maximum Allowed Login Attempts |
Maximum Allowed Login attempts |
pollIntervalAllEngineStatus |
Poll All Interval Engine Status |
Poll Interval for All Engine Status |
pollIntervalEngineStatus |
Poll Interval Engine Status |
Poll Interval per engine |
disabledProtocols |
Disabled Protocols |
List of Disabled Protocols |
sessionIdleTimeout |
Session Idle Timeout |
Session Idle Timeout before it is disconnected |
rowsPerPage |
Rows Per Page |
Rows Per Page for UI tables |
backupDir |
Back Up Directory |
Directory to backup CM configurations during CM startup |
enableConfigBackup |
Enable Config Backup |
Enable Configuration backup during CM startup |
cmName |
CM Name |
The unique name of CM instance |
jmsQueuePushInterval |
JMS queue heartbeat interval |
The amount of time in seconds that Engine/CM may push events into the queue |
webServerSessionIdLength |
Web Server Session Id Length |
The minimum length of the session Id used by web server |
engineAuditLogJmsRoutingEnabled |
Enable JMS queuing for the Engine |
Enable JMS queuing for the engine |
auditLogJmsRoutingEnabled |
Enable JMS queuing for the CM |
Enable JMS queuing for the CM |
auditLogJmsConfigName |
JMS Connection info |
JMS Connection info |
jmsConfigs |
List of JMS Connection info in the system |
List of JMS connection info in the system |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
enabled |
Enabled |
Enable CM listen port |
port |
Listen Port |
Port at CM to use to listen for secure connections. |
Timeout |
Timeout |
Accepter Timeout |
ipAddress |
IP Address |
IP address at CM to use to listen for secure connections. |
secureConnection |
Secure Connection |
|
secureConnectionSet |
Secure Connection Set |
Used internally only |
slInfo |
SSL Info |
See SysSslInfo for expansion |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
clientAlias |
Client Alias |
Client Certificate alias |
serverAlias |
Server Alias |
Server Certificate alias |
keyStoreFile |
Key Store File |
Key Store File |
keyStorePassword |
Key Store Password |
Key Store Password |
trustStoreFile |
Trust Store File |
Trust Store File |
trustStorePassword |
Trust Store Password |
Trust Store Password |
cipherSuites |
Cipher Suites |
Cipher Suites |
protocol |
Protocol |
Protocol |
keyStoreType |
Key Store Type |
Key Store Type |
trustStoreType |
Trust Store Type |
Trust Store Type |
keyManagerAlgorithm |
Key Manager Algorithm |
SSL Key Manager Algorithm |
trustManagerAlgorithm |
Trust Manager Algorithm |
SSL Trust Manager Algorithm |
clientAuthentication |
Client Authentication |
Enable Client Authentication |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
passwordData |
Password Data |
Password that the user must provide to access Secure Proxy. It can be up to 28 alphanumeric characters and cannot include commas (,), double quotes (“), or single quotes (‘). The length of the password required is defined in the password policy configuration. |
passwordEncoding |
Password Encoding |
|
passwordPolicyId |
Password Policy Id |
Password policy to associate with the user you are configuring. You must configure a password policy before you can associate it with a user. Select a Password Policy ID from the pull-down list. |
properties |
Properties |
User Properties |
roles |
Roles |
User Roles |
clientKeyStore |
Client Key Store |
Select an SSH Authorized User Key Store to associate with the user from the drop-down list. |
clientKeys |
Client Keys |
Select the SSH Authorized User Keys to associate with the user from the drop-down list. |
clientKey |
Client key |
|
firstName |
First Name |
Given name of the user. Optional, |
lastName |
Last Name |
Surname of the user. Optional. |
Email Address |
||
pager |
Pager |
Pager number for the user. Optional. |
managerId |
Manager Id |
Manager information for the user. |
userStatus |
User Active |
Indicates the user status; user status could be active or inactive |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
keyType |
Key Type |
Key Type |
keyData |
Key Data |
Certificate/key data |
password |
Password |
Password for key certificate |
keyStoreType |
Key Store Type |
Key Store Type |
keyStoreProvider |
Key Store Provider |
Key Store Provider |
keyAlias |
Key Alias |
Key Certificate alias |
keyStoreData |
Key Store Data |
Key Store Data |
keyStorePassword |
Key Store Password |
Key Store Password |
keyPassphrase |
Key Passphrase |
Key Passphrase |
keyInHSM |
Key In HSM |
Indicate if certificate is stored in HSM |
issuerRDN |
Issuer RDN |
Certificate Issuer RDN |
subjectRDN |
Subject |
Certificate Subject |
serialNum |
Serial Number |
Certificate Serial Number |
versionNum |
Version Number |
Certificate Version Number |
validFrom |
Valid From |
Certificate start valid date |
validTo |
Valid To |
|
enabled |
Enabled |
Check Enable Certificate to allow the certificate to be used to authorize a secure communications session. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
userId |
User Id |
Backend User Id |
password |
Password |
Backend Password |
logLevel |
Log Level |
Node Logging Level identifies the level of logging to write to the log file for the inbound node. Logging options include: |
secureConnection |
Secure Connection |
|
sslInfo |
SSL Info |
See SSLInfo for expansion |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
peerAddressPattern; |
Peer Address Pattern |
Peer Address Pattern identifies the pattern to allow for the inbound connections to Secure Proxy. Valid values are alphanumeric characters and the following special characters: dash(-), underscore(_), colon(:), period(.), dollar sign($), forward slash(/), exclamation mark(!), tilde(~), asterisk(*), open parenthesis '(', close parenthesis ')' semicolon(;), question mark(?), at(@), and comma(,). You can define one of the following types of patterns |
policyId; |
Policy Id |
Policy is a pull-down list of policies you have created. Select the policy you want to associate with the inbound node you are creating. If a policy with the security attributes required has not been created, click +. |
addresses |
Addresses |
See NodeAddress for expansion |
stepInjection |
Step Injection |
Function to associate with the node you are defining. If a step injection policy with the attributes required has not been created, click +. |
routingName |
Routing Name |
Value used to select this SNODE as the outbound node during certificate-based routing. It must match the routing name returned by Sterling External Authentication Server. Valid values are 1-150 alphanumeric characters with no spaces. Special characters allowed are period (.), dash (-), and underscore (_). Set this field only if you are configuring certificate-based routing in Secure External Authentication Server |
port |
port |
Port number of the Backend Server. Valid values are 1-65535. |
serverAddress |
Server Address |
IP address or host name of the Backend server. Valid values are 1-200 alphanumeric characters with no spaces. Special characters allowed are period (.), dash (-), colon (:), and underscore (_). |
tcpTimeout |
TCP Timeout |
TCP Timeout identifies the number of seconds to wait for a TCP/IP request or response before ending the session. Default=90. |
destinationServiceName |
Destination Service Name |
Destination Service Name identifies the name of the service that is passed to Sterling External Authentication Server for use in authenticating services. If no value is provided, the SNODE name is used as the service name. |
outboundACLNodes |
OutBound ACL Nodes |
Outbound Access Control Nodes. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
validDestination |
Valid Destination |
|
validDestinationPort |
Valid Destination Port |
Primary Destination Port identifies the port to use to connect to the outbound server. Valid values are 1-65535. |
addresses |
Addresses |
See NodeAddress for expansion Primary Destination Address identifies the IP address or host name to use to connect to the outbound server. Valid values are 1-200 alphanumeric characters with no spaces. Special characters allowed are period (.), dash (-), colon (:), and underscore ( _ ) |
destinationServiceName |
Destination Service Name |
Destination Service Name identifies a destination server that can be accessed by the outbound node, when using Sterling External Authentication Server to map a user ID and password. Valid values are 1-255 alphanumeric characters and certain special characters. |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
keyCertName |
Key Certificate Name |
Key Certificate Name |
trustedCertNames |
Trusted Certificate Name |
List of Trusted Certificate Names |
keyStoreName |
Key Store Name |
Keystore that contains the key certificate |
trustStoreName |
Trust Store Name |
Truststore the contains the list of trusted certificate names. |
protocol |
Protocol |
The SSL Protocol to use to establish SSL security connections |
keyManagerAlgorithm |
Key Manager Algorithm |
|
cipherSuites |
Cipher Suites |
List<String> of ciphersuites |
clientAuthentication |
Client Authentication |
Flag that indicates if client authentication is enabled. |
clientAuthenticationCD |
Client Authentication CD |
Used to indicate if client authentication is enabled for Connect:direct protocol |
ccc |
Clear Command Channel |
Indicate if Clear Command Channel is enabled for FTP |
verifyCommonName |
Verify Common Name |
Indicate if Common verification is enabled |
certificateCommonName |
Certificate Common Name |
The Certificate common Name to verify |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
host |
Host |
Server IP Address |
port |
Port |
Server Port |
nodeName |
Node Name |
Outbound Node Name |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
engineName |
Engine Name |
Engine identifies the Secure Proxy server in the DMZ where traffic is first routed before being sent to the outbound secure Secure Proxy server. Select an engine from the list. You must define an engine before you can create an adapter. |
psInName |
Inbound Perimeter Server Name |
Inbound Perimeter Server field. To use a remote perimeter server, you must define the server before you associate it with an inbound connection. |
psOutName |
Outbound Perimeter Server Name |
Outbound Perimeter Server field. To use a remote perimeter server, you must define it before you can associate it with an outbound connection. |
eaPSName |
External Authentication Perimeter Server Name |
External Authentication Perimeter Server field. To use a remote perimeter server, you must define it before you can associate it with an Secure Proxy connection |
eaServerName |
External Authentication Server Name |
External Authentication Server identifies the server to use. Select the server from the pull-down list. You must define a Sterling External Authentication Server before you can select the server from the list. |
startupMode |
Startup Mode |
Startup Mode identifies how the adapter is started. Values are: |
useEA |
Use External Authentication |
Internal Field |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
providerType |
The JMS Queue Provider |
The JMS Queue Provider |
host |
Host where the JMS queue is running |
Host where the JMS queue is running |
port |
Port at which the JMS Queue is listening |
Port at which the JMS Queue is listening |
topic |
The configured JMS queue topic |
The configured JMS queue topic |
user |
The user that would be used to login |
The user that would be used to login |
password |
The user password into the JMS queue |
The user password into the JMS queue |
queueManager |
The queue Manager – valid only for IBM MQ |
The queue Manager – valid only for IBM MQ |
channelName |
The channel name, valid only for the IBM MQ |
The channel name, valid only for the IBM MQ |
name |
The unique name for this JMS configuration |
The unique name for this JMS configuration |
| Field Name |
Description |
Extends Configuration Base class |
|---|---|---|
createdBy |
Created By |
System Field |
createdTimestamp |
Created Timestamp |
System Field |
lastModifiedBy |
Last Modified By |
System Field |
lastModifiedTimestamp |
Last Modified Timestamp |
System Field |
status |
Status |
System Field |
lockedBy |
Locked By |
System Field |
lockedTimestamp |
Locked Timestamp |
System Field |
forceToUnlock |
Force To Unlock |
System Field |
name |
Name |
Name identifies the name to assign the Object. It can be up to 150 characters with no spaces. Special characters allowed are the period (.), dash (-), and underscore (_). |
description |
Description |
Description assigns a description to help identify the Object. Description can be up to 255 characters |
verStamp |
Version Stamp |
System Field |
formatVer |
Format Version |
System Field |
templateName |
Template Name |
System Field |