Automatic user provisioning

What it is for

Automatic provisioning relieves you of creating objects one by one. EasyUC scans the end users in the CUCM at a fixed interval. If a new user matches a rule, EasyUC creates for that user what the rule provides for: IP phone, Jabber clients, device profile, remote destination profile or mobile identity, voicemail and a translation pattern.

A rule belongs to one location and one package. Attributes determine which users it matches: either fields of the CUCM end user or attributes from an LDAP directory that is set up as an external source. Alternatively, you import a CSV file with user IDs. The devices are created in the CUCM through AXL from the templates of the package. After the run, EasyUC can send an e-mail with the result.

Prerequisites

• Role ROLE_APP_ADMIN. The interface shows the Administration menu only with this role.
• The cucm module is enabled. Without this module the interface locks the page.
• An active CUCM connection is selected in the header. The page always works with this connection.
• The location has at least one package. The selection list contains only locations to which packages are assigned.
• The package contains templates for everything the rule is to create (phone model, Jabber clients, device profile, user, translation pattern).
• The location has number ranges for automatic assignment.
• For matching through LDAP: an external source of the type LDAP.
• For e-mails: a working SMTP configuration.

Step by step: creating a rule

1. Select the EasyUC Cisco workspace in the header.
2. Open Administration → CUCM & Provisioning → Automatic Provisioning. The page is called Automatically User Setup.
3. Click Create. The dialog Create Automatically User Setup Config opens.
4. Select the location and then the Package.
5. If required, set Would you like to import a CSV with a list of enduser IDs for this location? and select the file.
6. Click Next Step. The dialog Update Automatically User Setup Config opens.
7. In the section Enduser Attributes, define how the rule recognizes users. For CUCM fields, select the attribute under Select enduser attribute matching the package and type the values under Add attribute fields (type a word and press enter). For LDAP, set Would you like to use an LDAP connection to match attributes? and select LDAP Connection (External Source) and the LDAP attribute.
8. Add further conditions with add new attribute.
9. In the section Enduser Auto-Configs, select the Enduser Template.
10. Under IP Phone, set up the desk phone: Model and Template, plus either Use LDAP fields for MAC address? or Enable Activation Code?.
11. Under Soft Phones, tick the Jabber clients you want.
12. If required, select the Device Profile Template and, under RD/MI, either RD with RDP Template or MI with MI Template and Device.
13. If required, enable Enable create Translation Patterns? and fill in Template, Number of last digits, Prefix and Sufix. Below the fields, the dialog shows the result for a sample number.
14. If required, enable Enable sending E-mails?, select Send as HTML or Send as PDF attachment and enter the recipients.
15. Select the Busy Trigger (1 or 2) and set Activate voicemail? if required.
16. Click Save.

Step by step: starting and monitoring operation

1. In the row of the rule, click Configuration action → Start Setup. Only then does the rule take part in the scans.
2. Switch on Enable Automatically Setup at the top and confirm the prompt Do you want to enable automatically setup? with Yes, do it.
3. Under Scan for new users, select the interval: every 1, 2, 4, 6, 12 or 24 hours (for example Every 2 hours).
4. Check the next run under Next Scan start at.
5. For an immediate run, click Scan NOW and confirm Do you want to scan for new users now?.
6. Open Configuration action → View Logs. The Location Logs show the Log Type, Log Message and Status (pending, success, not success) for each user.
7. Click No AUS Config Endusers to see users who did not match any rule during the scans.
8. With Configuration action → Stop Setup you take a rule out of operation.

Fields and options

Checking the result and narrowing down errors

• The column Start Setup shows whether the rule is running. Next Scan start at states the next scheduled time.
• The Location Logs contain one entry per user with the status success or not success. View configuration and View statistics show details of the run.
• No scan takes place: Enable Automatically Setup is off, or no interval has been selected yet. The page then shows a note asking you to start the first scan.
• A user is not picked up: the user is listed under No AUS Config Endusers. Compare the attribute and value with the CUCM user. Upper and lower case and spaces matter.
• A client or model is not selectable: the matching template is missing in the package.
• After the first run, a rule can be changed only to a limited extent. Edit appears in the action menu only as long as the rule has not been executed yet.
• After a partial failure, do not simply repeat Scan NOW. First check in the log which objects have already been created.