[Index]

Model: view/HcsSyncUsersVIEW

Sync and Purge LDAP Users

Full HTML Help

This procedure syncs or purges (deletes) users that were synced from an LDAP server.

Tip

Use the Action search to navigate Automate

  1. In the Admin Portal, select the hierarchy where the LDAP server exists.

  2. Go to LDAP Users.

  3. Configure the following:

    Setting Description
    Remove Log Messages Defines whether to remove user management logs before syncing or purging.
    Remove Log Direction

    Displays only when Remove Log Messages is enabled.

    Choose an option:

    • Local - removes logs at the hierarchy of the LDAP server.
    • Down - removes logs at and below the hierarchy of the LDAP server.
    LDAP Server Mandatory. Choose the organization unit of the LDAP server from which you need to sync or purge the users.
    LDAP Action

    Mandatory. Select an option from the drop-down to run either a sync or purge:

    • Synchronize users from LDAP
    • Purge local LDAP device resources

    Warning

    If you're choosing to run a purge, a system message displays onscreen to warn you that purging will result in the loss of data. All LDAP users imported from the selected LDAP server will be removed.

    It is recommended that you consider this warning carefully, and the consequences of a purge:

    • If "purge" mode on the LDAP user sync configuration is set to Manual, any subscribers associated with these LDAP users will be retained and converted to local subscribers.
    • If "purge" mode on the LDAP user sync configuration is set to Automatic, any subscribers associated with these users, as well as their devices and services, will be deleted.

  4. Save your changes.

    The transaction is triggered. View transaction progress and details in the Transaction Logs.

Related Topics

Transaction Logging and Audit in the Core Feature Guide.

Model Details: view/HcsSyncUsersVIEW

Title Description Details
Remove Log Messages When checked, the existing User Management Log Messages get cleared prior to performing the action. Whether the existing Log Messages are removed or not, new logs may result from the action.
  • Field Name: removeLogs
  • Type: Boolean
Remove Log Direction Select Local to remove logs at the hierarchy of the LDAP server. Select Down to remove logs at and below the hierarchy of the LDAP server. Note that this will remove all User Management logs according to the selected direction regardless of what triggered the log. Default: Down
  • Field Name: removeLogsDirection
  • Type: String
  • Default: Down
  • Choices: ["Local", "Down"]
LDAP Server LDAP Server
  • Field Name: ldapServer
  • Type: String
  • Choices: ["None"]
LDAP Action The action to perform.
  • Field Name: ldapAction
  • Type: String
  • Choices: ["Synchronize users from LDAP", "Purge local LDAP device resources"]
CUCM Action The action to perform.
  • Field Name: cucmAction
  • Type: String
  • Choices: ["Synchronize users, lines, and phones from CUCM"]
Network Device List The network device list to use when performing the action.
  • Field Name: ndlName
  • Type: String
  • Choices: [" "]
Note Indicates whether or not sync is possible.
  • Field Name: note
  • Type: String
User Sync Type Default: TBD
  • Field Name: userSyncType
  • Type: String
  • Default: TBD