Installing the Office 365 Application Endpoint

This section describes how to install the Office 365 application endpoint.

Note: To obtain information about the Office 365 application endpoint architecture, see the General Architecture section.

Preparing for Installation

  • The installation is automatically performed by the setup.cmd script included in the Office 365 application package. To obtain the script, perform the following actions:

    1. Upload the Office 365 application package to the Office 365 Application Endpoint Host.
    2. Unpack the application package.
    3. Unblock the contents of the O365-Web.zip file. To do this, right-click the file in Windows Explorer, click Properties, click Unblock, and click OK.
    4. Extract the contents of the O365-Web.zip file.
    5. Open Windows PowerShell Console.
    6. Go to the directory where the contents of the extracted O365-Web.zip file are located.
  • Obtain BackNet IP addresses of the Office 365 Application Endpoint Host. These IP addresses will be used for Office 365 gateway sites. Note that each Office 365 gateway site requires a separate BackNet IP address.
  • Prepare hostnames for Office 365 gateway sites. These hostnames must be resolved into corresponding BackNet IP addresses of the Office 365 Application Endpoint Host. Check it on the OA Operations Management Node and Office 365 Application Endpoint Host.
  • Obtain the APSC SSL certificate from the OA Operations Management Node. The APSC SSL certificate is located here: /usr/local/pem/APS/certificates/controller.pem. Upload the APSC SSL certificate to the Office 365 Application Endpoint Host. Open the certificate file in a text editor and delete the private part, which starts with "-----BEGIN RSA PRIVATE KEY-----" and ends with "-----END RSA PRIVATE KEY-----"; leave only the public part, which starts with "-----BEGIN CERTIFICATE-----" and ends with "-----END CERTIFICATE-----".
  • Make sure you have prepared the SQL Server databases for your Office 365 gateway applications. See the Preparing SQL Server Databases section for details.

Creating Office 365 Gateway Sites

Run the script using the following parameters:

  • GatewaySiteName: The name of the Office 365 gateway site. Note that the name must not contain dots and it must not be changed after the installation of the Office 365 application endpoint.
  • GatewayAppName: The name of the Office 365 gateway application. Note that this name must not contain dots.
  • GatewayIPAddress: The BackNet IP address of the Office 365 Application Endpoint Host. This IP address will be used by the Office 365 gateway site. Note that each Office 365 gateway site requires a separate BackNet IP address.
  • MOSIFactory: The CSP value must be used.
  • GatewaySiteCertSubject: The hostname of the Office 365 gateway site. The corresponding self-signed SSL certificate will be automatically generated by the script and used by the Office 365 gateway site.
  • APSControllerCertPath: The full path to the APSC SSL certificate file of the corresponding OA Operations Management Node. This SSL certificate will be used for securing communication between APSC and the Office 365 gateway application.
  • Force: If this parameter is specified, the script does not ask a user to confirm actions.

If you are going to use SQL Server 2012/2014 Express/Web/Standard/Enterprise (x64) as a storage solution, specify the following additional parameters:

  • SqlInstance: The SQL Server instance of the Office 365 gateway application database. The following formats are possible here:

    • <hostname or IP address of SQL Server instance> – If a default SQL Server instance is used.
    • <hostname or IP address of SQL Server instance>\<name of SQL Server instance> – If a non-default SQL Server instance is used.
  • SqlDatabase: The name of the Office 365 gateway application database.
  • SqlUser: The login name of the Office 365 gateway application database.
  • SqlPassword: The login password of the Office 365 gateway application database.

If you are going to use SQL Server 2014 Express LocalDB (x64) as a storage solution, specify the following additional parameter:

  • LocalDb: If this parameter is specified, the Office 365 gateway application database is automatically created in SQL Server 2014 Express LocalDB (x64).

If you need to send welcome messages to newly created Office 365 users, specify the following additional parameters:

  • SMTPHost: The IP address or hostname of the SMTP server which will be used for sending welcome messages to newly created Office 365 users.
  • SMTPPort: The port of the SMTP server.
  • SMTPFrom: The email address which will be specified in the From: field of welcome messages.
  • SMTPFromPassword: The password which will be used for SMTP authentication (the value of the SMTPFrom parameter will be used as a login). This parameter must be specified if SMTP authentication is required.
  • SMTPDoNotUseSsl: If this parameter is specified, SSL will not be used.

Examples for SQL Server 2014 Express LocalDB

For example, execute the following command to create the first Office 365 gateway site and Office 365 gateway application (SQL Server 2014 Express LocalDB (x64) is used as a storage solution):

./setup.cmd -GatewaySiteName Office365GatewaySite01 -GatewayAppName Office365GatewayApplication01 -GatewayIPAddress 192.168.10.10 -MOSIFactory CSP -GatewaySiteCertSubject office365gateway01.hosting.local -APSControllerCertPath C:\Temp\controller.pem -LocalDb -SMTPHost smtpserver.provider.com -SMTPPort 25 -SMTPFrom office365@provider.com -SMTPFromPassword smtppassword -Force

For example, execute the following command to create the second Office 365 gateway site and Office 365 gateway application (SQL Server 2014 Express LocalDB (x64) is used as a storage solution):

./setup.cmd -GatewaySiteName Office365GatewaySite02 -GatewayAppName Office365GatewayApplication02 -GatewayIPAddress 192.168.10.20 -MOSIFactory CSP -GatewaySiteCertSubject office365gateway02.hosting.local -APSControllerCertPath C:\Temp\controller.pem -LocalDb -SMTPHost smtpserver.provider.com -SMTPPort 25 -SMTPFrom office365@provider.com -SMTPFromPassword smtppassword -Force

Examples for SQL Server 2012/2014 Express/Web/Standard/Enterprise

For example, execute the following command to create the first Office 365 gateway site and Office 365 gateway application (SQL Server 2012/2014 Express/Web/Standard/Enterprise (x64) is used as a storage solution):

./setup.cmd -GatewaySiteName Office365GatewaySite01 -GatewayAppName Office365GatewayApplication01 -GatewayIPAddress 192.168.10.10 -MOSIFactory CSP -GatewaySiteCertSubject office365gateway01.hosting.local -APSControllerCertPath C:\Temp\controller.pem -SqlInstance o365sql.hosting.local\Office365Instance -SqlDatabase Office365GatewayApplication01 -SqlUser Office365GatewayApplication01 -SqlPassword password01 -SMTPHost smtpserver.provider.com -SMTPPort 25 -SMTPFrom office365@provider.com -SMTPFromPassword smtppassword -Force

For example, execute the following command to create the second Office 365 gateway site and Office 365 gateway application (SQL Server 2012/2014 Express/Web/Standard/Enterprise (x64) is used as a storage solution):

./setup.cmd -GatewaySiteName Office365GatewaySite02 -GatewayAppName Office365GatewayApplication02 -GatewayIPAddress 192.168.10.20 -MOSIFactory CSP -GatewaySiteCertSubject office365gateway02.hosting.local -APSControllerCertPath C:\Temp\controller.pem -SqlInstance o365sql.hosting.local\Office365Instance -SqlDatabase Office365GatewayApplication02 -SqlUser Office365GatewayApplication02 -SqlPassword password02 -SMTPHost smtpserver.provider.com -SMTPPort 25 -SMTPFrom office365@provider.com -SMTPFromPassword smtppassword -Force

This script will create the Office 365 gateway sites and Office 365 gateway applications.

Notes:

1. Replace the input parameter values with the values that belong to your Odin Automation installation.

2. The SqlInstance, SqlDatabase, SqlUser, SqlPassword parameters and the LocalDb parameter are mutually exclusive. Either the SqlInstance, SqlDatabase, SqlUser, SqlPassword parameters or the LocalDb parameter must be specified depending on the installed SQL Server edition and version.