License usage limit approaching-f5-all

License usage limit approaching-f5-all
0

License usage limit approaching-f5-all

Vendor: f5

OS: all

Description:
Some licenses are limited to a certain number of elements (such as maximum users). If any of the licenses is nearing its limit, an alert will be issued.

Remediation Steps:
Consider purchasing additional licenses.

How does this work?
This alert uses the F5 iControl REST API to retrieve current TPS and throughput of the unit.

Why is this important?
Depending on platform, license SSL Transactions Per Seconds (TPS), or system throughput could be limited. This metric will track and alert when the usage is nearing, or has reached the limit.

Without Indeni how would you find this?
An administrator could could periodically log into the device through SSH, enter TMSH and execute the command “show sys performance throughput detail raw” to get this data.

f5-tmsh-show-sys-performance-throughput-raw

name: f5-tmsh-show-sys-performance-throughput-raw
description: Get current SSL TPS
type: monitoring
monitoring_interval: 5 minutes
requires:
    vendor: f5
    product: load-balancer
    linux-based: 'true'
    shell: bash
comments:
    license-elements-used:
        why: |
            Depending on platform, license SSL Transactions Per Seconds (TPS), or system throughput could be limited. This metric will track and alert when the usage is nearing, or has reached the limit.
        how: |
            This alert uses the F5 iControl REST API to retrieve current TPS and throughput of the unit.
        without-indeni: |
            An administrator could could periodically log into the device through SSH, enter TMSH and execute the command "show sys performance throughput detail raw" to get this data.
        can-with-snmp: false
        can-with-syslog: false
steps:
-   run:
        type: SSH
        command: tmsh -q show sys performance throughput detail raw
    parse:
        type: AWK
        file: tmsh-show-sys-performance-throughput.parser.1.awk

f5-tmsh-show-sys-license-detail-show-sys-tmm-info-global

name: f5-tmsh-show-sys-license-detail-show-sys-tmm-info-global
description: Get the TPS limit, throughput limit and compression throughput limit
type: monitoring
monitoring_interval: 5 minutes
requires:
    vendor: f5
    product: load-balancer
    linux-based: 'true'
    shell: bash
comments:
    license-elements-limit:
        why: |
            License-limits can be used to regulate for instance SSL Transactions per second, APM maximum simultaneous users, maximum throughput of an F5 VE Edition or maximum compressed Mbits per second. It is important to track these whenever possible to ensure that no traffic disruption is caused by the license reaching the set threshold.
        how: |
            This script logs into the device through SSH and extracts the license limits.
        without-indeni: |
            Manual tracking by an administrator is usually the only method for knowing if a license limit is set and what it is.
        can-with-snmp: false
        can-with-syslog: false
    f5-service-check:
        why: |
            The service check date is located in the BIG-IP license and is the same as the date the license was last activated or the date the service contract for the device expires, whichever date is earlier. This alert would serve to let the administrators know that an upgrade to the latest version is not possible without a license reactivation.
        how: |
            This script logs into the device through SSH and extracts the service check date. The date is then compared to the latest entry in the official F5 list located at https://support.f5.com/csp/article/K7727.
        without-indeni: |
            Manual tracking by an administrator is usually the only method for knowing if a license reactivation is needed.
        can-with-snmp: false
        can-with-syslog: false
steps:
-   run:
        type: SSH
        command: tmsh -q -c "show sys license detail;show sys tmm-info global"
    parse:
        type: AWK
        file: tmsh-show-sys-license-show-sys-tmm-info-global.parser.1.awk

license_usage_limit

// Deprecation warning : Scala template-based rules are deprecated. Please use YAML format rules instead.

package com.indeni.server.rules.library.templatebased.crossvendor

import com.indeni.server.rules.RuleContext
import com.indeni.server.rules.library.templates.NearingCapacityWithItemsTemplateRule
import com.indeni.server.rules.RemediationStepCondition

/**
  *
  */
case class license_usage_limit() extends NearingCapacityWithItemsTemplateRule(
  ruleName = "license_usage_limit",
  ruleFriendlyName = "All Devices: License usage limit approaching",
  ruleDescription = "Some licenses are limited to a certain number of elements (such as maximum users). If any of the licenses is nearing its limit, an alert will be issued.",
  usageMetricName = "license-elements-used",
  limitMetricName = "license-elements-limit",
  applicableMetricTag = "name",
  threshold = 80.0,
  minimumValueToAlert = 2.0, // We don't want to alert if the license capacity is 1 and we're using one item, this is a common occurence and isn't an issue
  alertDescription = "Some licenses are nearing their limit. Review the list below.",
  alertItemDescriptionFormat = "The number of elements in use is %.0f where the limit is %.0f.",
  baseRemediationText = "Consider purchasing additional licenses.",
  alertItemsHeader = "Affected Licenses")(
  RemediationStepCondition.VENDOR_CISCO ->
    """|
      |1. Run the "show license usage" NX-OS command to display information about the current license usage and the expire date.
      |2. Run the "show license" NX-OS command to view the installed licenses.
      |3. Run the "show license usage XXX" NX-OS command e.g." sh license usage ENHANCED_LAYER2_PKG" to display information about the activated features which utilize this license.
      |4. Consider activate the grace-period for the license.
      |5. Order new license from the CISCO.
      |6. For more information please review the next Cisco guide:
      |https://www.cisco.com/c/m/en_us/techdoc/dc/reference/cli/nxos/commands/fund/show-license-usage.html
    """.stripMargin
)