This appendix provides information about the Oracle Communications Mobile Synchronization Gateway configuration files and parameters.
The mgserver.properties file contains the main configuration settings. It consists of configuration parameters and their current values.
Caution:
Do not edit this file by hand. Always use the mgadmin command to set configuration parameters.The format of the mgserver.properties file is:
parameter=value parameter=value : :
The mgservercreds.properties file contains the password configuration settings. It consists of configuration parameters that are passwords and their current values.
Caution:
Do not edit this file by hand. Always use the mgadmin command to set configuration parameters.The format of the mgservercreds.properties file is:
password_parameter=value password_parameter=value : :
You can provide options to the mgadmin command by including them in the mgadmin.properties file.
Table B-1 describes the parameters in the mgadmin.properties file.
Table B-1 mgadmin.properties File Parameters
| Parameter | Description |
|---|---|
|
userid |
Specifies the Oracle GlassFish Administrator user ID. |
|
hostname |
Specifies the GlassFish Server host name. |
|
port |
Specifies the GlassFish administration port (JMX connector port). |
|
secure |
Specifies the path to the truststore file used for a secure connection (HTTPS) to Glassfish Server. |
|
sslprotocols |
Specifies the supported SSL protocols (TLSv1, TLSv1.1, and TLSv1.2) for the JMX proxy to communicate with management beans in the server. |
The format of the mgadmin.properties file is:
parameter=value parameter=value : :
Table B-2 lists the configuration parameters and descriptions for Mobile Synchronization Gateway. See "Mobile Synchronization Gateway Command-Line Utilities" for information about updating or changing configuration parameters by using the mgadmin config modify command.
Table B-2 Mobile Synchronization Gateway Configuration Parameters
| Parameter | Type | Description | Default value |
|---|---|---|---|
|
base.ldapinfo.cachesize |
integer |
Size of the LDAP Authentication cache. |
1000 |
|
base.ldapinfo.cachettl |
integer (seconds) |
Time to live (in seconds) of cached LDAP Authentication info. |
60 |
|
base.ldapinfo.dcroot |
string |
Root of DC tree (Schema 1) or of the domain and users tree (Schema 2) in Directory Server |
Value derived from comm_dssetup.pl script. |
|
base.ldapinfo.defaultdomain |
string |
Default domain. |
Value derived from comm_dssetup.pl script. |
|
base.ldapinfo.domainattrs |
string |
Space separated list of LDAP attributes to use when retrieving domain information. |
externalAuthPreUrlTemplate externalAuthPostUrlTemplate mgStatus |
|
base.ldapinfo.loginseparator |
string |
Characters to be used as login separator (between userid and domain). |
@ |
|
base.ldapinfo.schemalevel |
integer |
Specifies the schema level. |
Value derived from comm_dssetup.pl script. |
|
base.ldapinfo.searchfilter |
string |
Specifies the search filter for looking up users during authentication when one is not specified in the inetDomainSearchFilter for the domain. The syntax is the same as inetDomainSearchFilter. For more information, see Communications Suite Schema Reference. |
(|(uid=%U)(mail=%o)) |
|
base.ldapinfo.serviceadmindn |
string |
DN of single administrator in LDAP in absence of administrative group. |
None |
|
base.ldapinfo.serviceadminsgroupdn |
string |
DN of service administrators group in LDAP. |
cn=Service Administrators,ou=Groups,UGSuffix |
|
base.ldapinfo.authldap.binddn |
string |
Distinguished Name to use when authenticating. |
None |
|
base.ldapinfo.authldap.bindpassword |
password |
Password to use when authenticating. |
None |
|
base.ldapinfo.authldap.ldaphost |
string |
Space-delimited list of host names. Each host name can include a trailing colon and port number. |
None |
|
base.ldapinfo.authldap.ldappoolrefreshinterval |
integer (minutes) |
Length of elapsed time until the failover Directory Server host reverts back to the primary Directory Server host. If set to -1, do not refresh the interval. |
1 |
|
base.ldapinfo.authldap.ldappoolsize |
integer |
Maximum number of connections for this pool. |
10 |
|
base.ldapinfo.authldap.ldapport |
integer |
Directory Server host port number to which to connect. Ignored for any host name that includes a colon and port number. |
389 |
|
base.ldapinfo.authldap.ldaptimeout |
integer (seconds) |
Timeout for all LDAP operations. |
60 |
|
base.ldapinfo.authldap.ldapusessl |
boolean |
Use SSL to connect to the LDAP host. |
false |
|
base.ldapinfo.authldap.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end LDAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
base.ldapinfo.userattrs |
string |
Space separated list of LDAP attributes to retrieve from user entries during the authentication phase. |
mail ismemberof |
|
base.ldapinfo.ugldap.binddn |
string |
Distinguished Name to use when authenticating. |
cn=Directory Manager |
|
base.ldapinfo.ugldap.bindpassword |
password |
Password to use when authenticating. |
None |
|
base.ldapinfo.ugldap.ldaphost |
string |
Space-delimited list of host names. Each host name may include a trailing colon and port number. |
localhost:389 |
|
base.ldapinfo.ugldap.ldappoolrefreshinterval |
integer (minutes) |
Length of elapsed time until the failover Directory Server host reverts back to the primary Directory Server host. If set to -1, do not refresh the interval. |
1 |
|
base.ldapinfo.ugldap.ldappoolsize |
integer |
Maximum number of connections for this pool. |
10 |
|
base.ldapinfo.ugldap.ldapport |
integer |
Port number to which to connect. Ignored for any host name that includes a colon and port number. |
389 |
|
base.ldapinfo.ugldap.ldaptimeout |
integer (seconds) |
Timeout for all LDAP operations. |
60 |
|
base.ldapinfo.ugldap.ldapusessl |
boolean |
Use SSL to connect to the LDAP host. |
false |
|
base.ldapinfo.ugldap.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end LDAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
base.ldappool.*.binddn |
string |
Distinguished Name to use when authenticating. |
None, specified during LDAP pool creation |
|
base.ldappool.*.bindpassword |
password |
Password to use when authenticating. |
None, specified during LDAP pool creation |
|
base.ldappool.*.ldaphost |
string |
Space-delimited list of host names. Each host name may include a trailing colon and port number. |
localhost:389 |
|
base.ldappool.*.ldappoolrefreshinterval |
integer (minutes) |
Length of elapsed time until the failover Directory Server host reverts back to the primary Directory Server host. If set to -1, do not refresh the interval. |
1 |
|
base.ldappool.*.ldappoolsize |
integer |
Maximum number of connections for this pool. |
10 |
|
base.ldappool.*.ldapport |
integer |
Port number to which to connect. Ignored for any host name which includes a colon and port number. |
389 |
|
base.ldappool.*.ldaptimeout |
integer (seconds) |
Timeout for all LDAP operations. |
60 |
|
base.ldappool.*.ldapusessl |
boolean |
Use SSL to connect to the LDAP host. |
false |
|
base.ldappool.*.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols for the LDAP pool to communicate with the back-end LDAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
caldav.enable |
boolean |
Specifies whether the calendar service is enabled or not. |
true |
|
caldav.enablessl |
boolean |
Use SSL to connect to the server. |
true |
|
caldav.host |
string |
FQDN host name of the Oracle Communications Calendar Server host. |
None |
|
caldav.httppoolsize |
integer |
Maximum number of connections established to this host. |
50 |
|
caldav.mqhosturls |
string |
URL list of Calendar Server hosts on which Message Queue is running, separated by a comma. URL is in the form of host:port, for example: sc111.example.com,localhost:7676 |
None |
|
caldav.mqport |
integer |
Java Messaging Service port on the Calendar Server host to which to connect |
7676 |
|
caldav.port |
integer |
Calendar Server port number to which to connect. |
443 |
|
caldav.proxyadminid |
string |
The Calendar Server proxy administrative UID. This should be in the form: uid@domain if hosted domains setup is used. |
calmaster |
|
caldav.proxyadminpassword |
password |
The Calendar Server proxy administrative password. |
None |
|
caldav.requesttimeout |
integer (seconds) |
The time in seconds to wait for the Calendar Server host to respond before timing out. |
60 |
|
caldav.serviceuri |
string |
Context path at which the DAV interface is accessible. |
/dav |
|
caldav.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end Calendar Server service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
carddav.enable |
boolean |
Enables CardDAV protocol. |
true |
|
carddav.enablessl |
boolean |
Use SSL to connect to the Oracle Communications Contacts Server host. |
true |
|
carddav.host |
string |
FQDN host name of the Contacts Server host. |
localhost |
|
carddav.httppoolsize |
integer |
Maximum number of connections established to this Contacts Server host. |
50 |
|
carddav.mqhosturls |
string |
URL list of Contacts Server hosts on which Message Queue is running, separated by a comma. URL is in the form of host:port, for example: cs111.example.com,localhost:7676 |
None |
|
carddav.mqport |
integer |
Java Message Service port on the Contacts Server host to which to connect. |
7676 |
|
carddav.port |
integer |
Contacts Server port number to which to connect. |
443 |
|
carddav.proxyadminid |
string |
The Contact Server proxy administrative UID. This should be in the form: uid@domain if hosted domains setup is used. |
nabmaster |
|
carddav.proxyadminpassword |
password |
The Contacts Server proxy administrative password. |
None |
|
carddav.requesttimeout |
integer (seconds) |
The time in seconds to wait for the Contacts Server host to respond before timing out. |
60 |
|
carddav.serviceuri |
string |
Context path at which the CardDAV interface is accessible. |
/dav |
|
cardav.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end Contacts Server service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
imap.enablessl |
boolean |
Use SSL to connect to the Oracle Communications Messaging Server host. |
true |
|
imap.host |
string |
FQDN host name of the default IMAP server. Other IMAP servers are discovered through the mailhost LDAP attribute. |
None |
|
imap.inactivitytimeout |
integer (seconds) |
Time value in seconds after which unused connections are closed. One connection remains active. |
300 |
|
imap.port |
integer |
IMAP server port number to which to connect. |
993 |
|
imap.proxyadminid |
string |
IMAP server's proxy administrative UID. This should be of the form uid@domain if you use hosted domains. |
admin |
|
imap.proxyadminpassword |
password |
IMAP server's proxy administrative password. |
None |
|
imap.requesttimeout |
integer (seconds) |
The time in seconds to wait for the IMAP server to respond before timing out. |
60 |
|
imap.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end IMAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
iwc.host |
string |
FQDN host name of the default Oracle Communications Convergence server. |
None |
|
iwc.port |
integer |
Convergence server port number to which to connect. |
443 |
|
iwc.enablessl |
boolean |
Use SSL to connect to the Convergence host. |
true |
|
iwc.serviceuri |
string |
Context path at which the Convergence interface is accessible. |
/iwc/svc/iwcp |
|
iwc.proxyadminid |
string |
Convergence server's proxy administrative UID. This should be of form uid@domain if you use hosted domains. |
admin |
|
iwc.proxyadminpassword |
password |
Convergence server's proxy administrative password. |
None |
|
iwc.requesttimeout |
integer (seconds) |
The time in seconds to wait for the Convergence server to respond before timing out. |
60 |
|
iwc.httppoolsize |
integer |
Maximum number of connections established to this Convergence server. |
50 |
|
iwc.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end Convergence service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
log.mg.commands.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
|
log.mg.commands.logdir |
filepath |
Directory path for log files. |
logs |
|
log.mg.commands.loglevel |
loglevel |
Specifies the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
|
log.mg.commands.logtoparent |
boolean |
Enables logging to the GlassFish Server log file, in addition to the Mobile Synchronization Gateway logs. |
false |
|
log.mg.commands.maxlogfiles |
integer |
Maximum number of log files. |
10 |
|
log.mg.commands.maxlogfilesize |
integer (bytes) |
Maximum size of each log file. |
2097152 |
|
log.mg.errors.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
|
log.mg.errors.logdir |
filepath |
Directory path for log files. |
logs |
|
log.mg.errors.loglevel |
loglevel |
Specifies the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
|
log.mg.errors.logtoparent |
boolean |
Enables logging to the GlassFish Server log file, in addition to the Mobile Synchronization Gateway logs. |
false |
|
log.mg.errors.maxlogfiles |
integer |
Maximum number of log files. |
10 |
|
log.mg.errors.maxlogfilesize |
integer (bytes) |
Maximum size of each log file. |
2097152 |
|
log.mg.telemetry.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
|
log.mg.telemetry.logdir |
filepath |
Directory path for log files. |
logs |
|
log.mg.telemetry.loglevel |
loglevel |
Specifies the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
|
log.mg.telemetry.logtoparent |
boolean |
Enables logging to the GlassFish Server log file, in addition to the Mobile Synchronization Gateway logs. |
false |
|
log.mg.telemetry.maxlogfiles |
integer |
Maximum number of log files. |
10 |
|
log.mg.telemetry.maxlogfilesize |
integer (bytes) |
Maximum size of each log file. |
2097152 |
|
mail.autoreply.autoreplysubject |
string |
Subject for out of office email replies. |
Out of office |
|
mail.autoreply.autoreplytimeout |
integer |
Determines how often (in hours) users receive an out of office reminder. Values can be a positive integer between 1 and 300. |
168 |
|
mgcore.auth.cert.enable |
boolean |
Enables certificate-based client authentication. |
false |
|
mgcore.auth.cert.fallback |
boolean |
Enables fallback to username and password authentication. |
true |
|
mgcore.ldapattr.carddavuserattr |
string |
LDAP attribute whose presence in a user LDAP entry identifies a CardDAV user. This attribute is used only when both CardDAV and WABP address book protocols are configured. |
nabStore |
|
mgcore.ldapattr.commonname |
string |
Specifies the common name attribute. |
cn |
|
mgcore.ldapattr.externalauthposturltemplate |
string |
LDAP attribute that determines whether external authentication should do a post-authentication lookup against this domain. |
externalAuthPostUrlTemplate |
|
mgcore.ldapattr.externalauthpreurltemplate |
string |
LDAP attribute that determines whether external authentication is used against this domain. |
externalAuthPreUrlTemplate |
|
mgcore.ldapattr.inetuserstatus |
string |
LDAP attribute for status of user's account with regards to global service access. |
inetuserstatus |
|
mgcore.ldapattr.mail |
string |
Specifies the mail attribute. |
|
|
mgcore.ldapattr.mailalternateaddress |
string |
Separated list of alternate mail attributes. |
mailAlternateAddress |
|
mgcore.ldapattr.mailhost |
string |
Specifies the mail host attribute. |
mailhost |
|
mgcore.ldapattr.memberattr |
string |
LDAP attribute listing the groups of which the entry is a member. |
ismemberof |
|
mgcore.ldapattr.preferredlang |
string |
Language attribute. |
preferredLanguage |
|
mgcore.ldapattr.status |
string |
Mobile Synchronization Gateway status attribute that sets if service is active, inactive, deleted, or removed. |
mgStatus |
|
mgcore.ldapattr.uid |
string |
User ID attribute. |
uid |
|
mgcore.ldapsubject.emailsearchfiltertemplate |
string |
LDAP filter used when searching a subject by email address. The %s tokens are replaced by the email value to search. |
|(mail=%s)(mailalternateaddress=%s) |
|
mgcore.ldapsubject.ldapcachesize |
integer |
Maximum number of subjects (LDAP users, resources, and groups) kept in cache when mapping email and subjects. Entries are removed from the cache only when this maximum is reached or when any of the ldap subject configuration parameters are changed. Can be set to 0, indicating no cache. |
1000 |
|
mgcore.ldapsubject.ldapcachettl |
integer (seconds) |
Maximum time (in seconds) that subjects (LDAP users) are kept in cache when mapping emails and subjects. |
60 |
|
mgcore.ldapsubject.subjectattributes |
string |
Space separated list of LDAP attribute names to retrieve when doing a search for users. |
cn mgstatus mail mailalternateaddress preferredlanguage uid objectclass mailhost nabStore |
|
mgcore.serverdefaults.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols as the default for the various back-end services' sslprotocols configuration. That is, if the specific sslprotocols parameter is not set, it is set to the value of mgcore.serverdefaults.sslprotocols. |
TLSv1 TLSv1.1 TLSv1.2 |
|
mgcore.telemetry.filter |
string |
Space separated list of email addresses of users to be logged by telemetry. |
ALL |
|
mgcore.telemetry.forcetelemetry |
boolean |
Force telemetry for all users. Use caution when enabling as it generates a lot of data. |
false |
|
service.as.autodiscover.autodiscovername |
string |
Name element of the Server element in Autodiscover command responses from the EAS server. The Name element is an optional child element of the Server element in Autodiscover command responses that specifies the URL. If the Type element value is MobileSync, then the Name element specifies the URL that conveys the protocol. |
http://localhost |
|
service.as.autodiscover.autodiscoverurl |
string |
URL element in Autodiscover command responses from the EAS Server. The URL element is an optional child element of the Server element in Autodiscover command responses that specifies a URL that conveys the protocol, port, resource location and other information. |
http://localhost |
|
service.as.heartbeat.maxheartbeatinterval |
integer |
Maximum acceptable heartbeat interval. |
3540 |
|
service.as.heartbeat.minheartbeatinterval |
integer |
Minimum acceptable heartbeat interval. |
60 |
|
service.as.heartbeat.pollingheartbeatinterval |
integer |
Polling heartbeat interval (used when push is not enabled). Clients are awoken after this interval, with a status indicating that changes have occurred. A value of zero indicates that polling is disabled. |
0 |
|
service.as.monitor.enable |
boolean |
Enables the Mobile Synchronization Gateway monitoring service. You do not need to restart Mobile Synchronization Gateway for response time metrics. You do need to restart Mobile Synchronization Gateway for back-end connection status and data collection interval change. |
true |
|
service.as.monitor.probeinterval |
integer |
Specifies the interval, in seconds, of the monitoring service's data collection frequency, within the range of 60 to 3600. You must restart Mobile Synchronization Gateway for an interval change to take effect. |
300 |
|
service.as.push.mqpswd |
password |
Java Message Queue user password. |
guest |
|
service.as.push.mquser |
string |
Java Message Queue user name. |
guest |
|
service.as.push.port |
integer |
Specifies the port number of a message broker instance. |
7997 |
|
smtp.enablessl |
boolean |
Use SSL to connect to the SMTP server. |
false |
|
smtp.host |
string |
FQDN host name of the SMTP host. |
localhost |
|
smtp.inactivitytimeout |
integer (seconds) |
Time value in seconds after which unused connections are closed. |
300 |
|
smtp.port |
integer |
Port number to use to connect to the SMTP host. |
25 |
|
smtp.proxyadminid |
string |
SMTP server's proxy administrative UID. This should be of the form uid@domain if you use hosted domains. |
None |
|
smtp.proxyadminpassword |
password |
SMTP server's proxy administrative password. |
None |
|
smtp.requesttimeout |
integer (seconds) |
Time in seconds to wait for the SMTP server to respond before timing out. |
30 |
|
smtp.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end SMTP service. |
TLSv1 TLSv1.1 TLSv1.2 |
|
wabp.enablessl |
boolean |
Use SSL to connect to the Convergence server that provides WABP information. |
true |
|
wabp.host |
string |
FQDN host name of the Convergence server that provides WABP information. |
None |
|
wabp.httppoolsize |
integer |
Maximum number of connections established to this Convergence server that provides WABP information. |
50 |
|
wabp.port |
integer |
Port number to which to connect to the Convergence server that provides WABP information. |
443 |
|
wabp.proxyadminid |
string |
Proxy administrative UID of the Convergence server that provides WABP information. This should be of the form uid@domain if you use hosted domains. |
admin |
|
wabp.proxyadminpassword |
password |
Proxy administrative password of the Convergence server that provides WABP information. |
None |
|
wabp.requesttimeout |
integer (seconds) |
Time in seconds to wait for the Convergence server that provides WABP information to respond before timing out. |
60 |
|
wabp.serviceuri |
string |
Context path at which the WABP interface is accessible. |
/iwc/svc/wabp |
|
wabp.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end WABP service. |
TLSv1 TLSv1.1 TLSv1.2 |