Discovering Entities in Your Environment
After activating the appropriate Wisdom Pack license and installing the new integration, you must set up IO to discover the objects, called entities, in your environment, such as nodes, ports, storage, etc. Each discovery configuration is referred to as a discovery instance. You can have multiple discovery instances for each integration.
How Discovery Works
The Dell ObjectScale Integration discovers entities using the Dell ObjectScale REST APIs. After discovery runs, the following entities will be populated in the system.
Dell ObjectScale Replication Group
Dell ObjectScale Zone
Dell ObjectScale Node
Dell ObjectScale Storage Pool
Dell ObjectScale Disk
An integration license is not required for discovery. The license is required only for metrics collection.
Entity Types
Entities are the objects in your environment that IO can discover and monitor. From the Inventory tab in IO, you can view details about all the entities that IO discovers and reports on. You can view maps of entity relationships on the Topology tab.
The following are details about the entity types that were added for this Integration. Each entity type is represented in the IO UI by a different icon, as indicated in the entity types tables. Entities are listed in the tables by classification type.
Storage | |||||||||||||||||||||
Entity Type | Icon | Properties | |||||||||||||||||||
All Storage Arrays |  |
| |||||||||||||||||||
Storage/Dell ObjectScale | |||||||||||||||||||||
Entity Type | Icon | Properties | |||||||||||||||||||
Dell ObjectScale Zone | |
| |||||||||||||||||||
Dell ObjectScale Storage Pool |  |
| |||||||||||||||||||
Dell ObjectScale Node | |
| |||||||||||||||||||
Dell ObjectScale Disk |  |
| |||||||||||||||||||
Dell ObjectScale Replication Group | Unknown image: default |
| |||||||||||||||||||
Creating a New Discovery Instance
About This Task
Access to the target integration device is required for discovery to occur.
After you configure and subscribe to the integration instance, IO adjusts the appropriate Wisdom Pack license count to reflect additional license consumption.
Prerequisites
To perform this task, the user must meet the following requirements:
Ensure that all items identified in Installation Prerequisites have been met.
Have the following information available for integration configuration. These are needed so IO can connect to and collect metrics from the target integration device:
Warning
This integration does not support device connection through a proxy.
The following fields apply to all devices:
Name - A name which identifies this configuration from other configurations of the same type.
null - The interval (in minutes) at which data is collected from the target devices.
Monitoring Level - Determines if all devices in this configuration should poll for metrics and entity changes, just entity changes, or do nothing.
The following fields apply to each device entry:
IP Address/Hostname - The fully qualified domain name or IP address of the ObjectScale endpoint.
Port - The port number used to connect to the ObjectScale endpoint.
HTTPS - If checked, use HTTPS instead of HTTP when communicating with the ObjectScale endpoint.
SSL Certificate - The HTTPS certificate to use to establish a secure connection to the ObjectScale endpoint. This is only required if the certificate can't be validated via a standard root certificate chain. *
Self-signed certificates can be automatically fetched from the target device using these fields:
IP Address/Hostname
Port
Username - The username to use when connecting to the ObjectScale endpoint.
Password - The password to use (for the specified username) when connecting to the ObjectScale endpoint.
Licensing Status - Identifies the current licensing status of this configuration, which is determined after first publish.
* Required Field
If you intend to use credential sets when configuring devices, the credential sets must already have been created.
Steps
From the Settings page, click Integrations in the Probes and Integrations section.
Click View for the licensed integration you want to configure.
If this is an initial configuration: You are directed to the New Integration page to configure the first integration.
If there are existing configurations: The Integration page opens, displaying a list of all existing licensed and unlicensed configurations.
Click New.
The New Integration page displays.
Enter a Name for the configuration and click Next.
Each configuration must have a unique name to avoid save errors. If you are using more than one IO integration, it is recommended that a naming convention be used to ensure unique configuration names for each integration.
A second configuration page displays.
Note: Each integration has slightly different configuration pages. Shown above is a generic representation of a New Integration page.
Select a Poll Interval.
When selecting the poll interval, note that metric collection automatically begins when the first poll interval is reached.
Select a Monitoring Level: Discovery and Metric Collection (the default), Discovery Only, or Disabled. For new configurations, the default is the best choice. More information about each choice follows.
Discovery and Metric Collection (default) - for each polling interval, discovery and metrics will be collected, and licenses will be consumed.
Discovery Only - for each polling interval, discovery and metrics will be collected, but the metric data will be discarded. Licenses will not be consumed. Please note that this option will not lead to less load on the target system(s).
Disabled - all communication with the target system(s) will cease and licenses will not be consumed.
In the Devices area, add the configurations.
To add one configuration at a time, click Add.
You must select a credential set or enter a name/IP address, username, and password.
To add multiple configurations at one time, click Import, select a CSV file to upload, and then select how the file content should impact existing records.
You can Replace, Merge, or Add records.
Warning
If you select Replace, the entire contents currently in the table are deleted and replaced. This deletion cannot be undone.
See Using a CSV File for Configuration for details about using a configuration file.
Complete the device connection details and then click Save.
Click Save on the Configuration page.
If properly configured, the hosts are subscribed when the first metrics data is collected, based on the polling interval. You can verify subscription from the Integration page, that lists integration configuration instances.
Next Steps
License Validation
Per Device Licensing
This integration is licensed per Device and each device is listed in a separate row in the Devices table. Licensing status is shown in two places:
In the Licensing Status line of the Configuration section. Please note: the counts shown on this line are the number of devices (that is, rows in the Devices table) that are Licensed, Unlicensed, or Pending.
In the Licensing Status column of the Devices section.
License Evaluation
Licensing is evaluated under the following circumstances:
When data are received for the first time from a newly-configured integration or, for an existing integration, when transitioning from the Disabled or Discover Only monitoring levels to the Discover and Collect Metrics monitoring level.
Licensing is re-evaluated no more than once every fifteen minutes when discovered entities are either added or removed. Please note that an integration can become oversubscribed in these circumstances. If this happens, the integration configuration main view will show Collection Failed in the Last Metrics Collection column. Hovering over the error will show:
If licensing had previously failed, it is re-evaluated no more than once every hour during data collection.
Once a day at midnight (Appliance local time). If over-subscription is detected, data will be dropped and the integration configuration main view will show Collection Failed in the Last Metrics Collection column as shown above.
When a configuration is updated and saved. Please note: if the Monitoring Level is changed from Discover and Collect Metrics to either Discover Only or Disabled, any consumed licenses for that configuration or device will be released back to the appropriate license pool.
Editing Existing Discovery Instances
From the integration's Configuration page you can edit settings for the integration instance and for the hosts. You can edit each host individually, or use the Bulk Edit option.
You can also access the Credential Sets tab to create or change credentials associated with integration devices.
Prerequisites
If you intend to use credential sets when configuring devices, the credential sets must already have been created.
Steps
Navigate to Settings > Integrations and click View for the integration you want.
The Integration page displays a list of discovery configurations for the integration.
Click the Name of the integration instance you want to edit.
The Configuration tab displays for the integration.
Edit the Configuration settings.
Set the Name for the integration instance
Set the polling interval for metric collection
Set the monitoring level
Delete the entire integration configuration using the Delete option on the More menu.
Edit the Devices settings.
You can do the following:
Set the name or IP address of the device that the integration must access to collect metrics.
Add or remove a Credential Set.
When editing the credential set field, either select an alternative credential set, or select " - " and enter a username and password.
Set the username and password for logging in to the device.
The Username and Password fields are disabled if a Credential Set is selected.
Enable/disable Netstat data collection.
Add or Delete devices.
You can edit one device at a time using the Actions menu (down arrow).
You can edit multiple devices at a time by selecting the devices in the list and then clicking the Bulk Edit option.
Only the fields for which you enter a value are changed in all selected devices. Any field left empty is not overridden.
You can edit multiple devices at a time by using the option to Import a CSV file.
See Using a CSV File for Configuration for details about using a configuration file.
You can Replace, Merge, or Add records.
Warning
If you select Replace, the entire contents currently in the table are deleted and replaced. This deletion cannot be undone.
Click Save when you are finished editing the configuration.
Related Topics
Credential Sets
Credential sets define a common set of credentials (such as username and a password) for reuse by a single integration type. Creating credential sets is an optional part of an integration configuration.
Why Use Credential Sets?
Separating credentials from the configuration of specific devices provides for more efficient credential management. You can configure or edit credentials one time and apply them, rather than configuring or editing the same set of credentials for multiple hosts. You can also have one person create the credentials and a different person assign them.
Credential Set Creation
Credential sets are shared among all configurations of the integration type. For example, you can share the sets with all Solaris configurations, but you cannot share them between Solaris and Linux.
Before creating a credential set for an integration, you must have at least one device configured for that integration. You can create and assign a credential set during device configuration or afterward.
Credential sets can be created or modified directly from the UI, or you can import them in a CSV file. Credential sets can be added, edited, and removed from the Credential Sets tab, which is available from an integration's Configuration page. During host configuration, you can select to use either HTTP or HTTPS for communication. If using HTTPS, you need to provide a certificate file to upload.
When you save a configuration, the software verifies the new credential sets, checks for conflicts, ensures the selected host does not already have a credential set assigned, etc.
The name (Nickname) of the credential set must be unique. It is used as the key identifier when performing imports.
Modifying Credential Sets
Changes to any field, other than Nickname, in a credential set automatically and immediately take affect for all devices that reference the credential set.
If you change the name (Nickname) of a credential set, the change is not automatically populated to the devices using the credentials. You must manually update devices that reference the modified credentials.
You cannot delete or rename a credential set as long as it is being referenced by any integration device configuration. You must first remove the credential set from the devices that are using it.
If the host password is changed, the credential set must also be changed.
Related Topics
Creating and Assigning Credential Sets
Creating credential sets is an optional part of an integration configuration. They allow you to more easily manage access to devices in your environment.
The credentials that are used to connect to a device are separated from the address or connection information. This allows a common set of credentials to be shared across devices. When the common set of credentials change, they only need to be updated once, and all devices using that credential set can take advantage of the new credentials.
About This Task
You must create at least one integration configuration before you can create credential sets for that integration.
You can assign a credential set to a device after you add the device to the integration configuration.
Steps
Navigate to the integration Configuration page and select the Credential Sets tab.
Click Add and complete the Nickname, Username, and Password fields.
The Nickname is the key field used when importing CSV files for credential sets. It determines uniqueness for performing merge and update requests.
You can add multiple credential sets at a time by using the option to Import a CSV file.
See Using a CSV File for Configuration for details about using a configuration file.
Click Save, and then click Save on the integration page.
Tip
Clicking Save on the Add Credential Set page only adds the new configuration to the Credential Sets list. For the new credentials to persist, you must save the overall configuration.
Click the Configuration tab and select the device to which you will assign a credential set.
Click
(Actions) for the device and select Edit.The Edit Device page opens.
If you have multiple devices to which you are assigning a credential set, you can use the Bulk Edit or Import options.
Select the credential set for the device and click Save.
If you select "none" ( - ), the Username and Password fields are enabled.
When you save the configuration, the software verifies the new credential sets, checks for conflicts, ensures the selected host does not already have a credential set assigned, etc.
Related Tasks
Editing or Deleting Credential Sets
You can edit or delete credential sets from the Credential Sets tab, accessed from an integration's Configuration page.
About This Task
You cannot delete a credential set as long as it is being referenced by any integration configuration.
If you rename a credential set, devices that use that set do not automatically update; you must manually update the configuration for each device that references the renamed credentials.
If the credential set is still in use, you will receive a "nonexistent credential set" error when you save the integration configuration.
Prerequisites
If you need to create a new credential set, see Creating and Assigning Credential Sets.
If you are renaming or deleting a credential set, you must manually remove or update the credential set on all associated devices.
See Editing Existing Discovery Instances.
When editing the credentials, select an alternative credential set, or select " - " and enter a username and password.
Note
You do not need to remove credentials from devices if modifying username, password, or any field other than Nickname.
Steps
Navigate to the integration's Configuration page and select the Credential Sets tab.
Click
(Actions) for the credential set to be modified, then do one of the following:Select Edit, modify the configuration, and click Save.
Select Delete and click OK.
If you are modifying multiple credential sets, you can use the Bulk Edit or Import options.
Save the overall configuration.
Tip
Clicking Save on the Add Credential Set page only adds the new configuration to the Credential Sets list. For the new credentials to persist, you must save the overall configuration.
When you save the integration configuration, the software verifies the new credential sets, checks for conflicts, ensures the selected host does not already have a credential set assigned, etc. Changes take affect immediately for all devices that reference the credential set.
Next Steps
If you are removing or replacing the credential set for a device, you must manually edit the device configuration.
Editing Existing Discovery Instances
Related Topics
Using a CSV File for Configuration
When configuring an integration for discovery, you can import the configuration in a plain text file rather than adding the discovery instance from the UI. Using a configuration file is particularly helpful if you need to configure multiple devices to add to a integration instance.
The configuration file must meet the following requirements:
Only a Comma Separated Values (CSV) file is supported.
Terms must be comma separated with no spaces.
Do not include a header in the file.
The fields in the CSV file must appear in the same order as the fields in the Add>Devices window.
The required format is listed in the Import dialog for each integration.
Example 1, if there is a port field and you are using credential sets: Hostname/IP,PortNumber,CredSet1,,,,
Example 2, if there is a port field and you are not using credential sets: Hostname/IP,PortNumber,,Username,Password
Example 3, if there is not a port field and you are not using credential sets: Hostname/IP,,Username,Password
You can import a CSV file from the integration's configuration page. Navigation path: Settings>Integrations>View (for the chosen integration), then click the integration instance name in the table.
You have three options:
Replace: The contents of the table are replaced with the contents of the CSV file. Records are added, removed, and updated, as required.
Warning
If you select Replace, the entire contents currently in the table are deleted and replaced. This deletion cannot be undone.
Merge: Existing records are updated. Blank fields in the CSV file are ignored. New file records are added.
Add: Existing records are untouched. New records from the file are added.
Related Tasks: