Manage Tenants

Tenants provide you with separate monitoring environments that you administer from a single user interface. Tenants are not required for all deployments. The multi-tenancy feature lets an MSP monitor discrete customer networks and systems from a single instance of capm.
capm360
HID_View_a_List_of_Tenants
Tenants provide you with separate monitoring environments that you administer from a single user interface. Tenants are not required for all deployments. The multi-tenancy feature lets an MSP monitor discrete customer networks and systems from a single instance of
CA Performance Management
.
To edit the SNMP profiles, IP domains, or other configuration for a tenant, see Administer Tenants.
The global administrator manages tenants. View and manage tenants from the Manage Tenants page, which lists all the tenants in the system. To access the page, hover over
Administration
, and click
Group Settings: Tenants
.
These procedures required the default Administrator role:
Create a Tenant
During tenant creation, you can also create a tenant administrator and a tenant user. Unlike the global administrator, the tenant administrator can only see data and configuration for a single tenant. Data from other MSP customers is not accessible to a tenant administrator.
Follow these steps:
  1. On the Manage Tenants page, click
    New
    .
  2. Supply the required information, and make selections in the fields provided:
    • Name
    • Account ID
      This ID identifies the tenant and often corresponds to the MSP account number.
    • Description
    • Status
      Select whether the tenant is enabled or disabled.
    • Theme
      The theme is applied to all user accounts that are associated with this tenant.
    • Language
  3. Specify the credentials for the tenant administrator.
    This user has administrative privileges in the tenant.
  4. Specify the credentials for the default tenant user.
    This user account can access tenant-specific dashboards, but cannot access any administrative functions.
  5. Click
    Save
    .
    The new tenant definition is created. To configure monitoring in the tenant, Administer the tenant.
Clone a Tenant
To use status, theme, and language of an existing tenant as a template for a new tenant, select the existing tenant, and click
Clone
.
Tenant-specific information, such as users, groups, and SNMP profiles, is not copied. Configure monitoring in a tenant clone as if the clone is a new tenant.
Edit a Tenant
To modify any of the parameters that are defined during tenant creation, select the tenant, and click Edit. To charge monitoring configuration in the tenant, administer the tenant.
Disable and Enable a Tenant
To stop active monitoring of the infrastructure of a tenant, edit the tenant, and change the status to Disabled.
After you disable the tenant, the following results occur after the next synchronization with the Data Aggregator:
  • The Data Aggregator system stops all Data Collectors that are associated with the disabled tenant. Data Collectors have the 
    Not Collecting Data
    status. For any new Data Collector installations for a disabled tenant, the status is
    Not Collecting Data
    .
    If you reenable the tenant, manually restart the Data Collectors.
  • Polling is stopped for any devices and components that are being monitored for the tenant.
  • Historical data on the devices and components for the tenant remains accessible.
  • Discovery profiles that are associated with the tenant cannot be run. The discovery profiles have the
    Tenant Disabled
    state.
  • If a discovery profile is invalidated while a discovery is running, the discovery is aborted.
  • An audit event is generated on the Data Aggregator device for the disabled tenant.
When you enable a tenant, the following results occur after the next synchronization with the Data Aggregator:
  • Discovery profiles that are associated with the enabled tenant are validated. The discovery profiles display their current state.
  • An audit event is generated on the Data Aggregator device for the tenant.
To restart polling, restart the Data Collectors that are associated with the tenant. After the restart, the following results occur:
  • Polling is restarted for any devices and components that are being monitored on for the tenant.
  • Discovery profiles that are associated with the enabled tenant can be run. If the discovery profile is schedule, the system runs discovery at the next scheduled time.
Delete a Tenant
To remove a tenant and all associated data from the system, delete the tenant.
Information in a deleted tenant is not recoverable. To stop monitoring in a tenant, disable the tenant.
When you delete a tenant, the following definitions are deleted and cannot be recovered:
  • Data sources
  • SNMP profiles
  • IP domains
  • Threshold profiles
  • User accounts
  • Roles
  • Groups
  • Custom dashboards
  • Custom menus
After you delete the tenant, the following results occur after the next synchronization with the Data Aggregator:
  • Polling on the deleted devices and device components is stopped.
  • Historical data on the deleted devices and device components is no longer accessible.
  • An audit event is generated on the Data Aggregator device for the deleted tenant.
If you delete a tenant when an associated Data Collector is down, the Data collector immediately stops when it restarts. An error message is logged in the following file:
DC_installation_directory
/apache-karaf-<
vers
>/shutdown.log