sophos-xgs-firewall.yaml

extends:
  - _base.yaml
  - _generic-if.yaml
sysobjectid:
  - 1.3.6.1.4.1.2604.5
metadata:
  device:
    fields:
      vendor:
        value: "sophos"
      type:
        value: "firewall"
metrics:
  - MIB: HOST-RESOURCES-MIB
    symbol:
      name: cpu.usage
      OID: 1.3.6.1.2.1.25.3.3.1.2.196608
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: memory.usage
      OID: 1.3.6.1.4.1.2604.5.1.2.5.2.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: memory.total
      OID: 1.3.6.1.4.1.2604.5.1.2.5.1.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosDiskCapacity
      OID: 1.3.6.1.4.1.2604.5.1.2.4.1.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosDiskPercentUsage
      OID: 1.3.6.1.4.1.2604.5.1.2.4.2.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosSwapCapacity
      OID: 1.3.6.1.4.1.2604.5.1.2.5.3.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosSwapPercentUsage
      OID: 1.3.6.1.4.1.2604.5.1.2.5.4.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosLiveUsersCount
      OID: 1.3.6.1.4.1.2604.5.1.2.6.0
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosHTTPHits
      OID: 1.3.6.1.4.1.2604.5.1.2.7.0
    metric_type: monotonic_count
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosFTPHits
      OID: 1.3.6.1.4.1.2604.5.1.2.8.0
    metric_type: monotonic_count
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosPOP3Hits
      OID: 1.3.6.1.4.1.2604.5.1.2.9.1.0
    metric_type: monotonic_count
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosImapHits
      OID: 1.3.6.1.4.1.2604.5.1.2.9.2.0
    metric_type: monotonic_count
  - MIB: SFOS-FIREWALL-MIB
    symbol:
      name: sfosSmtpHits
      OID: 1.3.6.1.4.1.2604.5.1.2.9.3.0
    metric_type: monotonic_count
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosPoP3Service
#      OID: 1.3.6.1.4.1.2604.5.1.3.1.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosImap4Service
#      OID: 1.3.6.1.4.1.2604.5.1.3.2.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosSmtpService
#      OID: 1.3.6.1.4.1.2604.5.1.3.3.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosFtpService
#      OID: 1.3.6.1.4.1.2604.5.1.3.4.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosHttpService
#      OID: 1.3.6.1.4.1.2604.5.1.3.5.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosAVService
#      OID: 1.3.6.1.4.1.2604.5.1.3.6.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosASService
#      OID: 1.3.6.1.4.1.2604.5.1.3.7.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosDNSService
#      OID: 1.3.6.1.4.1.2604.5.1.3.8.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosHAService
#      OID: 1.3.6.1.4.1.2604.5.1.3.9.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosIPSService
#      OID: 1.3.6.1.4.1.2604.5.1.3.10.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosApacheService
#      OID: 1.3.6.1.4.1.2604.5.1.3.11.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosNtpService
#      OID: 1.3.6.1.4.1.2604.5.1.3.12.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosTomcatService
#      OID: 1.3.6.1.4.1.2604.5.1.3.13.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosSSLVpnService
#      OID: 1.3.6.1.4.1.2604.5.1.3.14.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosIPSecVpnService
#      OID: 1.3.6.1.4.1.2604.5.1.3.15.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosDatabaseService
#      OID: 1.3.6.1.4.1.2604.5.1.3.16.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosNetworkService
#      OID: 1.3.6.1.4.1.2604.5.1.3.17.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosGarnerService
#      OID: 1.3.6.1.4.1.2604.5.1.3.18.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosDroutingService
#      OID: 1.3.6.1.4.1.2604.5.1.3.19.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosSSHdService
#      OID: 1.3.6.1.4.1.2604.5.1.3.20.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosDgdService
#      OID: 1.3.6.1.4.1.2604.5.1.3.21.0
#      enum:
#        untouched: 0
#        stopped: 1
#        initializing: 2
#        running: 3
#        exiting: 4
#        dead: 5
#        frozen: 6
#        unregistered: 7
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosHAStatus
#      OID: 1.3.6.1.4.1.2604.5.1.4.1.0
#      enum:
#        disabled: 0
#        enabled: 1
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosDeviceCurrentHAState
#      OID: 1.3.6.1.4.1.2604.5.1.4.4.0
#      enum:
#        notApplicable: 0
#        auxiliary: 1
#        standAlone: 2
#        primary: 3
#        faulty: 4
#        ready: 5
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosDevicePeerHAState
#      OID: 1.3.6.1.4.1.2604.5.1.4.5.0
#      enum:
#        notApplicable: 0
#        auxiliary: 1
#        standAlone: 2
#        primary: 3
#        faulty: 4
#        ready: 5
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosBaseFWLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.1.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosBaseFWLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.1.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosNetProtectionLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.2.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosNetProtectionLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.2.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosWebProtectionLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.3.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosWebProtectionLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.3.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosMailProtectionLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.4.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosMailProtectionLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.4.2.0
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosWebServerProtectionLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.5.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosWebServerProtectionLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.5.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosSandstromLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.6.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosSandstromLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.6.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosEnhancedSupportLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.7.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosEnhancedSupportLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.7.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosEnhancedPlusLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.8.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosEnhancedPlusLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.8.2.0

#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosCentralOrchestrationLicRegStatus
#      OID: 1.3.6.1.4.1.2604.5.1.5.9.1.0
#      enum:
#        trial: 1
#        unsubscribed: 2
#        subscribed: 3
#        expired: 4
#      TODO: enum in scalar metric is not supported yet (keep this metric and this
#        comment in profile until it's fixed)

# Commented since the value is not a numerical value but a DisplayString
#  - MIB: SFOS-FIREWALL-MIB
#    symbol:
#      name: sfosCentralOrchestrationLicExpiryDate
#      OID: 1.3.6.1.4.1.2604.5.1.5.9.2.0

  - MIB: SFOS-FIREWALL-MIB
    table:
      name: sfosIPSecVpnTunnelTable
      OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1
    symbols:
      - name: sfosIPSecVpnTunnel
        constant_value_one: true
      - name: sfosIPSecVpnActiveTunnel
        OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.8
    metric_tags:
      - symbol:
          name: sfosIPSecVpnConnName
          OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.2
        tag: sfos_ip_sec_vpn_conn_name
      - symbol:
          name: sfosIPSecVpnConnDes
          OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.3
        tag: sfos_ip_sec_vpn_conn_des
      - symbol:
          name: sfosIPSecVpnPolicyName
          OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.4
        tag: sfos_ip_sec_vpn_policy_name
      - symbol:
          name: sfosIPSecVpnConnMode
          OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.5
        tag: sfos_ip_sec_vpn_conn_mode
      - symbol:
          OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.6
          name: sfosIPSecVpnConnType
        tag: sfos_ip_sec_vpn_conn_type
        mapping:
          1: host-to-host
          2: site-to-site
      - symbol:
          name: sfosIPSecVpnLocalgwPort
          OID: 1.3.6.1.4.1.2604.5.1.6.1.1.1.1.7
        tag: sfos_ip_sec_vpn_localgw_port

metric_tags:
  - OID: 1.3.6.1.4.1.2604.5.1.1.2.0
    symbol: sfosDeviceType
    tag: sfos_device_type
  - OID: 1.3.6.1.4.1.2604.5.1.1.3.0
    symbol: sfosDeviceFWVersion
    tag: sfos_device_fw_version
  - OID: 1.3.6.1.4.1.2604.5.1.1.6.0
    symbol: sfosIPSVersion
    tag: sfos_ips_version