Skip to main content
Version: Omada Identity on-premises 16.0.1

Omada Provisioning Service

Omada Provisioning Service (OPS) runs as a Windows service.

Omada recommends

Run the service under a service account. If you use a service account, have the account credentials ready before starting the installation.

Database​

The OPS installer creates the required database during installation. If you do not want the installer to create it, you can create the database yourself. Do not add any database tables. The installer creates all the required tables.

note

During installation, the OPS database is configured to enable the snapshot setting. This setting is required for OPS to operate properly.

If you create the OPS database manually, enable both read_committed_snapshot and allow_snapshot_isolation for the database before using Omada Identity.

Namespace reservation​

During installation, the OPS installer creates a namespace reservation for http://+:8000/ProvisioningService/Service/ for the service account selected during installation.

If you change the account later, update the namespace reservation manually.

To show the current namespace reservation, run:

  • netsh http show urlacl http://+:8000/ProvisioningService/Service/

To delete an existing namespace reservation, run:

  • netsh http delete urlacl http://+:8000/ProvisioningService/Service/

To add a new namespace reservation, run:

  • netsh http add urlacl http://+:8000/ProvisioningService/Service/ user="domain\user"
note

If the service runs as Local System Account, use a user of the BUILTIN\ type.

User rights for installing the Omada Provisioning Service​

The user installing OPS must have the following rights and database roles.

Local group settings​

In Local Group settings, the user must belong to a group that is allowed to install software on the system. This is usually Local Administrators.

SQL Server roles​

To create the database during installation, the user must have the dbcreator server role.

If an empty database was created before installation, the user installing the OPS must have the db_owner role for that database.

note

To install OPS on a SQL Server instance, the installing user must have sysadmin and securityadmin permissions for the service account.

Login Properties dialog box on the Server Roles page with dbcreator, public, securityadmin, and sysadmin selected

Configure SSL​

During installation, the Windows Communication Foundation (WCF) services are configured to use HTTP by default. Omada recommends using the more secure Secure Sockets Layer (SSL) protocol.

To configure SSL:

  1. Change the service configuration file so that the service uses SSL.
  2. Update the OPS instance in Enterprise Server (ES).
  3. Verify that the certificate is correctly linked to the port.

Change the service configuration file​

  1. Using a text editor, open Omada.OPS.Service.exe.config in the C:\Program Files\Omada Identity Suite\Provisioning Service folder.

  2. Comment out or remove the following element:

    <service name="Omada.OPS.Service.WCF.Impl.AllWcfServices" behaviorConfiguration="ProvisioningServiceServiceBehaviorSecure">
  3. Immediately after the element in step 2, find the following commented-out section and uncomment it:

    <service name="Omada.OPS.Service.WCF.Impl.AllWcfServices" behaviorConfiguration="ProvisioningServiceServiceBehaviorSecureHttps">

The default port number is 8001.

Next, update the OPS instance in ES.

Update the OPS instance in ES​

  1. In the Omada Identity Portal, go to Setup > Administration > Connectivity > OPS Instances.

  2. In the OPS Instances view, select the check box next to the default instance, then click Edit.

    OPS Instances view with the Default instance selected and the Edit button highlighted
  3. In the Edit OPS Instance view, select the Use SSL check box.

  4. In the Port field, change the value to 8001.

    note

    In the Server field, specify the server hosting the service.

    When using SSL, you cannot specify IP addresses.

    Edit OPS Instance page with Server set to demo, Port set to 8001, and Allow insecure connections and Use SSL selected

Next, verify the connection and confirm that the certificate is correctly linked to the port.

Verify the connection​

note

If you are upgrading OPS from version 12.1 or earlier, add the reservation manually as shown in step 1 of this procedure.

You do not need to perform this step for a clean Omada Identity installation.

  1. The installer creates a URL reservation for HTTPS on port 8001. To add the reservation manually, open a command prompt on the OPS server and run the following command. Replace the user value with the account running the OPS service:

    netsh http add urlacl url=https://+:8001/ProvisioningService/Service/ user=xxxxx\srvc_omada
  2. Import your SSL certificate to the server where OPS is installed.

    note

    Make sure the certificate has a private key and is imported to the following path in the Windows certificate store:

    (Local Computer)\Personal\Certificates

    Otherwise, you may see this error:

    SSL Certificate add failed, Error: 1312 A specified logon session does not exist. It may already have been terminated.

    To import your certificate with its private key, run the following PowerShell command. Replace the file path with the location where you saved your SSL certificate (.pfx) file. You are prompted for the certificate password:

    Import-PfxCertificate -FilePath [c:\mycert.pfx] -CertStoreLocation cert:\LocalMachine\My -Password (Read-Host -AsSecureString -Prompt "Certificate password")

  3. To get the certificate thumbprint, run the following PowerShell command:

    Get-ChildItem -Path cert:\LocalMachine\My\

    note

    Copy or write down the thumbprint. You will need it in the next step.

  4. Bind the SSL certificate to the OPS service using the following command. Replace the certhash value with the thumbprint from step 3:

    netsh http add sslcert ipport=0.0.0.0:8001 certhash=d32d8ff70fb4c27977fada0ce2d41facddd9c0d9 appid={86521b84-b247-4a15-b698-9d0bcc61e520}
  5. After completing all the steps in this procedure, restart the OPS service.

Install the Omada Provisioning Service​

  1. Double-click Omada Provisioning Service.exe to launch the installation wizard. On the welcome screen, click Next.

  2. Select the destination folder. By default, this is C:\Program Files\Omada Identity Suite\Provisioning Service. To choose a different folder, click Change... and browse to the desired location. Click Next.

  3. Enter the name of the database server where you are installing the database, then select an authentication method. Omada recommends connecting with Windows authentication credentials of current user.

    In Name of database catalog, specify the database name. You can use a manually created, empty database or create a new database. You can also use the default name shown. Click Next.

    Database Server page of the installation wizard with (local) as the server, Windows authentication selected, and ProvisioningService as the database catalog
  4. Specify whether to run the service as a Local System Account or a Service Account. Omada recommends using a dedicated service account. If you select Service Account, enter the credentials. The credentials are stored only as part of the Windows service registration.

    Service Settings page with Service Account selected and the Domain, User, and Password fields filled in
  5. Under Custom Setup, select the features you want to install.

    Custom Setup page with the Provisioning Service feature and the REST, Database, PowerShell, LDAP, AD, and SAP connectors

    The Provisioning Service feature installs the service, database, and connectors for REST, Database, PowerShell, Lightweight Directory Access Protocol (LDAP), Active Directory (AD), and SAP, if selected.

  6. Click Next, then click Install. After the selected features have been installed, click Finish to close the installation wizard.

  7. On the server, start OPS in Administrative Tools > Services. The service does not start automatically as part of the installation.

Troubleshooting​

Installer displays a warning for the service account​

When a warning about the service account appears, click Yes and continue with the installation.

Alternatively, close the installer. Before restarting it, right-click the installer file and select Run as administrator.

Installer does not detect an old version of OPS/ODW and will not upgrade​

See the Installer does not detect an old version of OPS/ODW and will not upgrade section.

Unable to start the Omada Provisioning Service​

If the OPS does not start, open Event Viewer and look for entries with OPS as the source. Review any errors.

Missing namespace reservation​

If you get the following error when starting the service, the namespace reservation is incorrect or missing. See Namespace reservation for information about creating the correct reservation.

HTTP could not register URL http://+:8000/ProvisioningService/service/

note

The reservation must be made for the account running the service.

Unable to log in to the database​

If the service account does not have sufficient rights to open the Provisioning Service database, the following error appears:

Cannot open database "ProvisioningService" requested by the login.
The login failed.

Login failed for user 'megamart\srvc_omada'

Use Microsoft SQL Server Management Studio to grant the service account login db_owner rights to the Provisioning Service database.

Login Properties dialog box for the service account on the User Mapping page, with the ProvisioningService database mapped and db_owner selected

Omada DEMO/DEV system: Performance issue​

If Omada Identity performs very poorly on VMware virtualization, try disabling Receive Segment Coalescing.

Error installing OPS as a service user​

When you run the OPS installer as a service user, the following error may appear:

Installer error 27506 saying that the CreateUserAndAssignRoles.sql script failed because the login already has an account under a different user name

To resolve the issue causing this error:

  1. Create the ProvisioningService database. Skip this step if the database already exists.

  2. Change the database owner to an account other than the service user.

    Database Properties dialog box for ProvisioningService with the Owner field set to the service account
  3. Make sure the service user has db_owner rights for the ProvisioningService database.

    Login Properties dialog box for the service account with the ProvisioningService database mapped and db_owner selected
  4. Run the installer again as the service user. This is the user name entered in the User: field during installation.

    Service Settings page of the installation wizard with Service Account selected and the User field set to srvc_omada

Omada Identity Timer Service not starting automatically​

When setting up a new environment, startup may improve if one or more Omada Identity Windows services run on the same server as SQL Server and depend on the SQL Server Windows service. Use the following commands for the Timer Service, OPS, and Role and Policy Engine (RoPE), as applicable:

sc config OETSVC depend=MSSQLSERVER

sc config "Omada ProvisioningService" depend=MSSQLSERVER

sc config RoPE_0 depend=MSSQLSERVER

The sc command works only in the Windows Command Prompt.

note

These commands overwrite the existing dependencies of the three services. Before running them, open the Services application, view each service's properties, and note its current dependencies. To retain existing dependencies, add them to the commands above, preceded by a slash.

For example, if the Timer Service depends on the Windows Management Instrumentation (WMI) Performance Adapter service, use this command:

sc config OETSVC depend=MSSQLSERVER/wmiApSrv