Administration Guide

  • Docs Home
  • Community Home

6. Device Access Control Lists

6.1. About Device Access Control Lists in Zenoss

Note

This feature is available only with Zenoss Enterprise.

The Device Access Control List (ACL) Enterprise ZenPack (ZenDeviceACL) adds fine-grained security controls to Zenoss. For example, this control can be used to give limited access to certain departments within a large organization or limit a customer to see only his own data. A user with limited access to objects also has a more limited view of features within the system. As an example, most global views, such as the network map, event console, and all types of class management, are not available. The Device List is available, as are the device organizers Systems, Groups, and Locations. A limited set of reports can also be accessed.

6.2. Key Elements

Following are key elements of device ACLs.

6.2.1. Permissions and Roles

Actions within Zenoss are assigned permissions. For instance to access the device edit screen you must have the “Change Device” permission. Permissions are not assigned directly to a user since this would be difficult to manage. Instead, permissions are granted to roles, which are then assigned to a user. A common example is the ZenUser role in Zenoss Core. Its primary permission is “View,” which grants read-only access to all objects. ZenManagers have additional permissions such as “Change Device,” which grants them access to the device edit screen. The Device ACL ZenPack has the role ZenRestrictedManager, which allows a more limited set of device edit functions. In Zenoss Core, when you assign a role to a user using the Roles field on the Edit tab, it is “global." When creating a restricted user you may not want to give that user any global role.

6.2.2. Administered Objects

Device ACLs provide limited control to various objects within the system. Administered objects are the same as the device organizers: Groups, Systems, and Locations and Devices. If access is granted to any device organizer, it flows down to all devices within that organizer. To assign access to objects for a restricted user, you must have the Manager or ZenManager roles. Zenoss grants access to objects is granted using the “Administered Objects” tab of a user or user group. To limit access, you must not assign a “global” role to the user or group.

6.2.3. Users and Groups

Users and user groups work exactly as they would normally. See the section in the User Management section of this guide dealing with users and groups.

6.2.4. Assigning Administered Object Access

For each user or group there is a tab called “Administered Objects." The menu has an add item for each type of administered object. Adding an object will pull up a dialog box with live search on the given type of object. After an object has been added you can assign it a role. Roles can be different for each object so a user or group might have ZenUser on a particular device but ZenManager on a location organizer. If multiple roles are granted to a device though direct assignment and organizer assignment the resulting permissions will be additive. In the example above, if the device was within the organizer the user would inherit the ZenManager role on the device.

6.2.5. Portlet Access Control

Within Zenoss Core, portlet access can be controlled. This is important for Device ACLs.

6.3. Setup and Configuration Examples

Refer to the following examples for setup and configuration steps.

6.3.1. Restricted User with ZenUser Role

  1. As admin or any user account with Manager or ZenManager role, create a user named acltest. Set a password for the user.

  2. From the user’s Edit tab, make sure that no role is assigned.

  3. Select the user’s “Administered Objects” tab.

  4. From, the menu, select the “Add Device…” item and add an existing device to that user.

    The device’s role will default to ZenUser.

  5. Log out of your browser, or open a second browser and then log in as acltest.

  6. Click on the “Device List”.

    You should see only the device you assigned to acltest.

  7. Navigate to the device and notice that the Edit tab is not available. This is because you are in read-only mode for this device.

6.3.2. Restricted User with ZenManager Role

Following the example above:

  1. Change the acltest user’s role to “ZenManager” on the device. ( You must to do this as a user with ZenManager global rights.)

  2. Go back to the acltest user “Administered Objects” tab and set the role on the device to ZenManager.

  3. As acltest, navigate back to the device. You now have access to the Edit tab.

6.3.3. Adding Device Organizers

  1. Go to the Groups root and create a group called “RestrictGroup."

  2. Go to the acltest user’s Administered Objects tab and add the group to the user.

  3. Logged in as acltest, notice that the Navigation menu has the Groups item. Group can be added to a user.

  4. Place a device within this group and as acltest you should not only see the device within the group but also in the device list

6.3.4. Restricted User Organizer Management

  1. Give the acltest user ZenManager on your restricted group.

  2. As acltest, you can now add sub-organizers under the restricted group.

6.3.5. Viewing Events

A user in restricted mode does not have access to the global event console. The available events for the user can be seen under his organizers.

6.4. Detailed Restricted Screen Functionality

6.4.1. Dashboard

By default, the dashboard is configured with only three portlets:

  • Object Watch List

  • Device Issues

  • Production State

These have content that will be restricted to objects for a given user.

6.4.2. Device List

The device list is automatically filtered to devices of a restricted user scoped to accessible devices. There are no menu items available.

6.4.3. Device Organizers

Device organizers control groups of devices for a restricted user. Every device added to the group will be accessible to the user. Permissions will be inherited down multiple tiers of a device organizer.

6.4.4. Reporting

Reports are limited to device reports and performance reports.