Supported Target Versions
AIX 7.1 TL02 instant of TL02

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
3.1.0
  • Added support for SSH keypair authentication.
  • Added support to print error log line part of logfile monitoring.
3.0.2
  • Fixed process monitoring issue and added support for PID monitoring.
  • Fixed remote shell connection timeout issue by re-trying the command execution with 60 secs timeout.
3.0.1Fixed the code for below two issues:
  • Skip the processes which are not giving the response.
  • Copy ".sh" script file into target system only on first run and not on every polling of log monitor.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
3.0.0Log file monitoring support is added.
2.0.0Initial 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)
  • Non-root user should have read permissions to monitor “.pid” files (to read the file data).

Roles and Permissions

Users with read permissions are required to fetch service status related data.

Application Migration

  1. 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.
  2. 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 TypeMetric NamesUnitApplication VersionMetric Description
IBM AIX Serveribmaix_server_openFileDescriptors_Utilization%2.0.0Open File Descriptors Used Percentage.
ibmaix_server_openFileDescriptors_UsedCountcount2.0.0Current number of Open File Descriptors.
ibmaix_server_loggedInUsers_Pct%2.0.0Current number of logged in users percentage.
ibmaix_server_loggedInUsers_Countcount2.0.0Current number of logged in users.
ibmaix_server_runningProcesses_Pct%2.0.0Current running processes percentage.
ibmaix_server_runningProcesses_Countcount2.0.0Current number of running processes.
ibmaix_server_Semaphores_UsedCountcount2.0.0Current number of semaphore ID’s in use.
ibmaix_server_messageQueueIDs_UsedCountcount2.0.0Current number of message queue ID’s in use.
ibmaix_server_sharedMemoryIDs_UsedCountcount2.0.0Current number of shared memory ID’s in use.
ibmaix_server_cpu_total_Utilization%2.0.0System CPU Utilization.
ibmaix_server_cpu_logicalProcessor_Utilization%2.0.0System CPU logical processor Utilization.
ibmaix_server_cpu_Load2.0.0Average cpu load for 1 min, 5 min and 15 min.
ibmaix_server_realMemory_ScanRatepsec2.0.0Memory scan rate in pages per second.
ibmaix_server_realMemory_pageOuts_PagesPerSecpsec2.0.0Memory page out rate in pages per second.
ibmaix_server_realMemory_pageOuts_KiloBytesPerSecKBps2.0.0Memory pages page out rate in KiloBytes per second.
ibmaix_server_realMemory_memory_Utilization%2.0.0Memory Utilization.
ibmaix_server_swapMemory_Utilization%2.0.0Swap memory utilization in percent.
ibmaix_server_individual_SwapArea_Utilization%2.0.0Individual swap area utilization in percent.
ibmaix_server_fileSystem_Space_UsedInMBMB2.0.0File system space usage in MB.
ibmaix_server_fileSystem_Space_DeltaInKBMB2.0.0File system space usage(KB) delta.
ibmaix_server_fileSystem_Inodes_Utilization%2.0.0File system Inodes utilization percent.
ibmaix_server_fileSystem_Inodes_Usage_Numbercount2.0.0File system Inodes usage number.
ibmaix_server_fileSystem_Inodes_Deltacount2.0.0File system Inodes usage delta.
ibmaix_server_fileSystem_Mount_ChangeDetection2.0.0File 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_OutTrafficKbps2.0.0Monitors Out traffic of each interface for IBM AIX Devices.
ibmaix_server_network_interface_InDiscardspsec2.0.0Monitors Network in discards of each interface for IBM AIX Devices.
ibmaix_server_network_interface_OutPacketspackets/sec2.0.0Monitors Out packets of each interface for IBM AIX Devices.
ibmaix_server_network_interface_OutErrorscount2.0.0Monitors network out errors of each interface for IBM AIX Devices.
ibmaix_server_network_interface_OutDiscardspsec2.0.0Monitors network Out Discards of each interface for IBM AIX Devices.
ibmaix_server_network_interface_InPacketspackets/sec2.0.0Monitors in Packets of each interface for IBM AIX Devices.
ibmaix_server_network_interface_Status2.0.0Monitors status of each interface for IBM AIX Devices. Possible values 0-down, 1-up.
ibmaix_server_network_interface_Collisionscount2.0.0Monitors network collisions of each interface for IBM AIX Devices.
ibmaix_server_network_interface_InErrorscount2.0.0Monitors network in errors of each interface for IBM AIX Devices
ibmaix_server_network_interface_InTrafficKbps2.0.0Monitors In traffic of each interface for IBM AIX Devices.
ibmaix_server_process_RunningStatus2.0.0Monitors 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.

  1. 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)

  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)

  3. 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

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
  5. 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.
  6. Search for the application using the search option available. Alternatively, use the All Categories option to search.
IBM-AIX
  1. Click ADD on the IBM AIX Server tile and select the version.
  2. From the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
IP Address/ Host NameIP address/host name of the IBM AIX.
PortPort

Note: By default 22 is displayed.
CredentialSelect the Credential from the drop-down list.

(Optional): Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Select the credential type as Application or SSH from the drop-down list.
    Application: Enter the following information.
    • Name: Credential name.
    • Description: Brief description of the credential.
    • User Name: User name.
    • Password: Password.
    • Confirm Password: Confirm password.
    SSH: Enter the following information.
    • Name: Credential name.
    • Description: Brief description of the credential.
    • Authentication Type: Select Password or Keypair from the dropdown list.
    • User Name: User name.
    • Password: Password.
    • Confirm Password: Confirm password.
    • Port: Enter the port information
      Note: By default 22 is the port.
    • Connection Timeout: Enter the connection timeout information.
Additional ConfigurationEnter 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”: "" } ].
  • Process monitoring support is available if user provides process name or pid file absolute path or combination of both as shown below:
    • Processes": “sshd,cron,/etc/mail/sendmail.pid,init,inetd,qdaemon,/etc/syslog.pid
      Note: Absolute path should be given for PID file & user should have read permissions to the file.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect 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).

  1. 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.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:

    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

IBM-AIX

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.

  1. 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.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

Veeam
  1. Select an existing registered profile.
Veeam
  1. 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

View the IBM AIX Details

To discover resources for IBM AIX:

  1. Navigate to Infrastructure > Search > OS > IBM AIX Server.
  2. The IBM AIX SERVER page is displayed, select the application name.
  3. The RESOURCE DETAILS page appears from the right.
  4. Click the ellipsis () on the top right and select View details.
  5. Navigate to the Attributes tab to view the discovery details.
IBM-AIX
  • Click the Metrics tab to view the metric details for IBM AIX Server.
IBM-AIX

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 TypeResource Type
All TypesresourceName
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.