Supported Target Versions |
---|
AIX 7.1 TL02 instant of TL02 |
Application Version Details
Application Version | Bug fixes / Enhancements |
---|---|
3.0.1 | Fixed the code for below two issues:
|
3.0.0 | Log file monitoring support is added. |
2.0.0 | Initial Version with discovery and monitoring features. |
Introduction
IBM’s Advanced Interactive executive, or AIX, is a series of proprietary UNIX-based operating systems built by IBM. AIX is the open standards-based UNIX operating system providing secure, scalable, and robust infrastructure solutions for enterprise.
Monitoring Use Case: IBM AIX helps to collect the metric values with respect to time and alerts your team to act immediately in case of any threshold breach or unexpected metric behavior observed based on configurations. In a way it helps you with smooth functioning of business with minimal or zero downtime in case of any infrastructure related issues occurring.
Prerequisites
- OpsRamp Classic Gateway 14.0.0 and above.
- OpsRamp Nextgen Gateway 14.0.0 and above.
Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.. - Should be able to connect to IBM-AIX portal via SSH with the provided IpAddress/Hostname and the credentials
- Credential Set: root users & non-root users member of system user group.
- Non-root users should have a home directory and make sure the user has read, write & execute permissions to that directory for log file monitoring.
(As part of log file monitoring, the application will copy the .sh script file into the AIX device which is responsible for log file monitoring . This will copy the file into user’s home directory)
Roles and Permissions
Users with read permissions are required to fetch service status related data.
Application Migration
Check for the gateway version as a prerequisite step - classic gateway-12.0.1 and above.
Notes:- You only have to follow these steps when you want to migrate from sdk 1.0 to sdk 2.0.
- For first time installation below steps are not required.
- Application name should be the same.
- Disable all installed integrations configurations for that application. This is to make sure no discovery and monitoring requests are processed.
- Install and Add the configuration to that sdk 2.0 application.
Note: refer to Configure and Install the IBM AIX Integration & View the IBM AIX Details sections of this document. - During the migration from SDK 1.0 to SDK 2.0, ensure that you uncheck the Bypass Resource Reconciliation checkbox.
Once all discoveries are completed with the sdk 2.0 applicaion, follow any one of the approaches.
- Direct uninstallation of the sdk1.0 adaptor application through the uninstall API with skipDeleteResources=true in the post request
End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}
Request Body:
{
"uninstallReason": "Test",
"skipDeleteResources": true
}
(OR)
- Delete the configuration one by one through the Delete adaptor config API with the request parameter as skipDeleteResources=true
End-Point:
https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/config/{configId}?skipDeleteResources=true.
- Finally, uninstall the adaptor application through API with skipDeleteResources=true in the post request.
End-Point:
https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}
Request Body:
{
"uninstallReason": "Test",
"skipDeleteResources": true
}
Supported Metric
Click here to view the supported metrics
Native Type | Metric Names | Unit | Application Version | Metric Description |
---|---|---|---|---|
IBM AIX Server | ibmaix_server_openFileDescriptors_Utilization | % | 2.0.0 | Open File Descriptors Used Percentage. |
ibmaix_server_openFileDescriptors_UsedCount | count | 2.0.0 | Current number of Open File Descriptors. | |
ibmaix_server_loggedInUsers_Pct | % | 2.0.0 | Current number of logged in users percentage. | |
ibmaix_server_loggedInUsers_Count | count | 2.0.0 | Current number of logged in users. | |
ibmaix_server_runningProcesses_Pct | % | 2.0.0 | Current running processes percentage. | |
ibmaix_server_runningProcesses_Count | count | 2.0.0 | Current number of running processes. | |
ibmaix_server_Semaphores_UsedCount | count | 2.0.0 | Current number of semaphore ID’s in use. | |
ibmaix_server_messageQueueIDs_UsedCount | count | 2.0.0 | Current number of message queue ID’s in use. | |
ibmaix_server_sharedMemoryIDs_UsedCount | count | 2.0.0 | Current number of shared memory ID’s in use. | |
ibmaix_server_cpu_total_Utilization | % | 2.0.0 | System CPU Utilization. | |
ibmaix_server_cpu_logicalProcessor_Utilization | % | 2.0.0 | System CPU logical processor Utilization. | |
ibmaix_server_cpu_Load | 2.0.0 | Average cpu load for 1 min, 5 min and 15 min. | ||
ibmaix_server_realMemory_ScanRate | psec | 2.0.0 | Memory scan rate in pages per second. | |
ibmaix_server_realMemory_pageOuts_PagesPerSec | psec | 2.0.0 | Memory page out rate in pages per second. | |
ibmaix_server_realMemory_pageOuts_KiloBytesPerSec | KBps | 2.0.0 | Memory pages page out rate in KiloBytes per second. | |
ibmaix_server_realMemory_memory_Utilization | % | 2.0.0 | Memory Utilization. | |
ibmaix_server_swapMemory_Utilization | % | 2.0.0 | Swap memory utilization in percent. | |
ibmaix_server_individual_SwapArea_Utilization | % | 2.0.0 | Individual swap area utilization in percent. | |
ibmaix_server_fileSystem_Space_UsedInMB | MB | 2.0.0 | File system space usage in MB. | |
ibmaix_server_fileSystem_Space_DeltaInKB | MB | 2.0.0 | File system space usage(KB) delta. | |
ibmaix_server_fileSystem_Inodes_Utilization | % | 2.0.0 | File system Inodes utilization percent. | |
ibmaix_server_fileSystem_Inodes_Usage_Number | count | 2.0.0 | File system Inodes usage number. | |
ibmaix_server_fileSystem_Inodes_Delta | count | 2.0.0 | File system Inodes usage delta. | |
ibmaix_server_fileSystem_Mount_ChangeDetection | 2.0.0 | File system mount point change detection. It detects if any file system mount point is removed and if any new mount point added into the system. Below are the possible values: 0 - Available, 1 - Newly Added, 2 - Removed. | ||
ibmaix_server_network_interface_OutTraffic | Kbps | 2.0.0 | Monitors Out traffic of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_InDiscards | psec | 2.0.0 | Monitors Network in discards of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_OutPackets | packets/sec | 2.0.0 | Monitors Out packets of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_OutErrors | count | 2.0.0 | Monitors network out errors of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_OutDiscards | psec | 2.0.0 | Monitors network Out Discards of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_InPackets | packets/sec | 2.0.0 | Monitors in Packets of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_Status | 2.0.0 | Monitors status of each interface for IBM AIX Devices. Possible values 0-down, 1-up. | ||
ibmaix_server_network_interface_Collisions | count | 2.0.0 | Monitors network collisions of each interface for IBM AIX Devices. | |
ibmaix_server_network_interface_InErrors | count | 2.0.0 | Monitors network in errors of each interface for IBM AIX Devices | |
ibmaix_server_network_interface_InTraffic | Kbps | 2.0.0 | Monitors In traffic of each interface for IBM AIX Devices. | |
ibmaix_server_process_RunningStatus | 2.0.0 | Monitors status of each user mentioned process. Possible values 0-Not Running, 1- Running. |
Default Monitoring Configurations
IBM AIX Server has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. Users can customize these default monitoring configurations as per their business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends performing this activity before installing the application to avoid noise alerts and data.
Default Global Device Management Policies
OpsRamp has a Global Device Management Policy for the Native Type of IBM AIX Server. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:
{appName nativeType - version}
Ex: ibm-aix-server IBM AIX Server - 2(i.e, appName = ibm-aix-server, nativeType = IBM AIX Server , version = 2)
Default Global Templates
OpsRamp has a Global template for the Native Type of IBM AIX Server. You can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:
{appName nativeType 'Template' - version}
Ex: ibm-aix-server IBM AIX Server Template - 2(i.e, appName = ibm-aix-server, nativeType = IBM AIX Server, version = 2)
Default Global Monitors
OpsRamp has a Global Monitors for the Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:
{monitorKey appName nativeType - version}
Ex: IBM AIX Server Monitor ibm-aix-server IBM AIX Server 2 (i.e, monitorKey =IBM AIX Server Monitor, appName = ibm-aix-server, nativeType = IBM AIX Server , version = 2)
Configure and Install the IBM AIX Integration
- From All Clients, select a client.
- Go to Setup > Account.
- Select the Integrations and Apps tab.
- The Installed Integrations page, where all the installed applications are displayed.
Note: If there are no installed applications, it will navigate to the ADD APP page. - Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.

- Click ADD on the IBM AIX Server tile and select the version.
- From the Configurations page, click + ADD. The Add Configuration page appears.
- Enter the below mentioned BASIC INFORMATION:
Funtionality | Description |
---|---|
Name | Enter the name for the configuration. |
IP Address/ Host Name | IP address/host name of the IBM AIX. |
Port | Port Note: By default EnterpriseManager Port: 9398 / Service Provider Console Port: 1280 is displayed. |
Credential | Select the Credential from the drop-down list. Notes:
|
Additional Configuration | Enter the additional configuration. Note: By default { "File Systems": "JFS,JFS2,NameFS,nfs,GPFS", "Mount Points": "/tmp,/usr", "Processes": "sshd,syslogd,cron,init,inetd,qdaemon,sendmail" } is added. |
Notes:
- Ip Address/Host Name and Port should be accessible from Gateway.
- Select the following:
- App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
- Log File Monitoring: configure the values for below fields as per your log file monitoring use case:
- Log File Configuration:[ { “Name”: “”, “File Name”: “”, “Rotated File Name”: “”, “Expression”: “”, “Check Type”: “”, “Threshold”: “”, “Severity”: "" } ].
- Select the below mentioned Custom Attribute:
Functionality | Description |
---|---|
Custom Attribute | Select the custom attribute from the drop down list box. |
Value | Select the value from the drop down list box. |
Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).
In the RESOURCE TYPE section, select:
- ALL: All the existing and future resources will be discovered.
- SELECT: You can select one or multiple resources to be discovered.
In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
- Minutes
- Hourly
- Daily
- Weekly
- Monthly
Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
Click NEXT.
(Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

- Select an existing registered profile.

- Click FINISH.
The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.
Modify the Configuration
See Modify an Installed Integration or Application article.
Note: Select the IBM AIX Server application.
View the IBM AIX Details
To discover resources for IBM AIX:
- Navigate to Infrastructure > Search > OS > IBM AIX Server.
- The IBM AIX SERVER page is displayed, select the application name.
- The RESOURCE DETAILS page appears from the right.
- Click the ellipsis (…) on the top right and select View details.
- Navigate to the Attributes tab to view the discovery details.

- Click the Metrics tab to view the metric details for IBM AIX Server.

Resource Filter Input Keys
IBM AIX server application Resources are filtered and discovered based on below keys.
Click here to view the Supported Input Keys
Resource Type | Resource Type |
---|---|
All Types | resourceName |
hostName | |
ipAddress | |
MAC address | |
make | |
model |
Supported Alert Custom Macros
Customize the alert subject and description with below macros then it will generate alerts based on customization. Supported macros keys:
Click here to view the alert subject and description with macros
${resource.name}
${resource.ip}
${resource.mac}
${resource.os}
${resource.type}
${resource.make}
${resource.model}
${resource.serialnumber}
${Custome Attributes in the resource}
Risks, Limitations & Assumptions
Application can handle Critical/Recovery failure alert notifications for below two cases when user enables Notification Alert in configuration:
- Connectivity Exception
- Authentication Exception
Application will send any duplicate/repeat failure alert notification for every 6 hours.
Application cannot control monitoring pause/resume actions based on above alerts. Metrics can be used to monitor aix-server resource and can generate alerts based on the threshold values.
OpsRamp has provided 22 as default SSH Port value for connecting to aix end device via SSH. Users can modify this value from the application configuration page at any point of time if required.
No support of showing activity log and applied time.
This application supports both Classic Gateway and NextGen Gateway .
Currently we do not have monitoring support for below things.
- Hardware metrics.
- Programmable Resource Monitoring.
- Processes (We provided one metric for each process RunningStatus. i.e, ibmaix_server_process_RunningStatus)
For log monitoring, we expect below json payload as input:
- “Name” can be any string used to identify individual log configuration.
- “File Name” is a combination of folder path and file name. Folder path should contain the exact path for the file as prefix. File name can be any valid string or regular expression.. In case of file not found with specified file name, alert will be generated with the severity specified by the user.
Example 1:/var/adm/ras/Age.?t.log
Matches:Agent.log, Ageat.log ,..
- “Rotated File Name” is similar to filename field but specifying the rotated file. This field is optional.
- “Expression” can be any valid string or regular expression used to specify the search string. It’s a mandatory field.
- “Check Type” can be either “exists” or “not exists”(case insensitive). It’s a mandatory field.
- “Threshold” can be any valid integer. Alert will be generated in case of specified threshold breach happens.
- “Severity” used to specify the alert type to be created in case of expression found. Possible values are CRITICAL,WARNING,INFO and OK (case insensitive).
- Atmost we can monitor only two log files including rotated file.
Log File configuration
[{ "Name":"", "File Name":"", "Rotated File Name":"", "Expression":"", "Check Type":"", "Threshold":"", "Severity":"" }]
We do not process logs of size greater than 1GB.
We do not process logs for the first request, since it leads to performance issues due to huge data. We will consider the latest logs ( logs generated between first and second polls) from the second request and process accordingly.
No recovery alerts are generated for expression related alerts. You will get recovery only for file not found alerts