Skip to main content

Configuration (on-prem only)

Connectivity package installation​

Connectivity packages are part of the Omada.Connectivity.StandardCollectors and Omada.Connectivity.StandardConnectors packages. To install a connectivity package in your installation of Omada Identity:

  1. Download the latest connectivity package from the Omada Hub. Go to Omada Identity Product Downloads > Connectivity.

  2. Extract the contents of the downloaded .zip files to a folder (for example: C:\Users\administrator\Downloads\).

  3. Run the cmd (command line) as the administrator.

  4. Navigate to the folder where you extracted the package and to the Registration Utility folder within (for example: C:\Users\administrator\Downloads\RegistrationUtility).

  5. Register the connectivity package using the Register Connectivity tool supplied with the package.

  6. Go one folder up (to **C:\Users\administrator\Downloads\Omada.Connectivity.**name.<version>.XX) and run the command:

    powershell . ./deploy.ps1
    note

    The deploy.ps1 script copies binaries to the appropriate places. It starts and stops services, if necessary, for example OPS and ES Timer Services. It is necessary to run the script on all servers hosting ES, ODW or OPS.

  7. Run the Enterprise Server and go to Setup > Administration > Connectivity > Packages. Check if the installed connectivity package is on the package list.

Registering the Connectivity package​

You can register the connectivity package using Omada Identity OData API. Using the integrated authentication, run the following command:

Omada.SDK.RegisterConnectivity.exe -F "C:\Users\administrator\Downloads\Omada.Connectivity.<name>.<version>.<XX>\Artifacts\Registration\Registration.xml" -url "https://<url>/OData"

where:

  • C:\Users\administrator\Downloads is changed to the actual location where you extracted the Connectivity package
  • name is the name of the downloaded Connectivity package
  • XX is the actual version of the downloaded Connectivity package
  • url is the actual URL to your Omada Identity OData API endpoint

If you are a Data Administrator, you can perform the registration in the context of another user. To do so, run the following command:

 Omada.SDK.RegisterConnectivity.exe -F "C:\Users\administrator\Downloads\Omada.Connectivity.<name>.<version>.<XX>\Artifacts\Registration\Registration.xml" -url "https://<url>/OData" -user "<user>" -pwd "<password>"

where:

  • C:\Users\administrator\Downloads is changed to the actual location where you extracted the Connectivity package
  • name is the name of the downloaded Connectivity package
  • XX is the actual version of the downloaded Connectivity package
  • url is the actual URL to your Omada Identity OData API endpoint
  • user is your actual administrator username
  • password is your actual password

Register a new system​

  1. In Systems view, click New to register a new system.
  2. Enter the name of the new system in the Name field of the pop-up screen.
  3. Enter the unique system ID in the System ID field.
  4. From the Category dropdown, select New.
  5. Select the relevant Connectivity radio button.
  6. In the Content field, select the type of data that you want to import from and provision to the system.