Back to the list of connectors[1]

Pure Storage FA Series (REST Token Authentication)

Description

This connector monitors environmental sensors, physical disks, management network cards and fiber ports on Pure Storage FA Series arrays. It relies on the Pure Storage API version 1.13 and higher. The token must be provided as a password.

This connector supersedes:

enterprise[3] hardware[4] pure[5] storage[6]

Target

Typical platform: Pure Storage

Operating system: Storage System

Prerequisites

Leverages: Pure Storage REST API

Technology and protocols: HTTP/REST

This connector is not available for the local host (it is applicable to remote hosts only).

Examples

CLI

metricshub HOSTNAME -t storage -c +PureStorageRESTToken --https --http-port 443 -u USERNAME

metricshub.yaml

resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: storage
        connectors: [ +PureStorageRESTToken ] # Optional, to load only this connector
        protocols:
          http:
            https: true
            port: 443 # or probably something else
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt

Connector Activation Criteria

The Pure Storage FA Series (REST Token Authentication) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • The HTTP Request below to the managed host succeeds:
    • POST /api/1.13/auth/session
    • Request Header:
      ${file::embeddedFile-1}
    • Request Body:
      {"api_token": "%{PASSWORD}"}
    • The entire response (header + body) contains: session (regex)

Metrics

Type Collected Metrics Specific Attributes
blade
  • hw.status{hw.type="blade", state="degraded|failed|ok"}
  • hw.status{hw.type="blade", state="present"}
  • blade_name
  • hw.parent.type
  • id
  • info
  • model
  • name
  • serial_number
enclosure
  • hw.status{hw.type="enclosure", state="degraded|failed|ok"}
  • hw.status{hw.type="enclosure", state="present"}
  • id
  • model
  • name
  • serial_number
  • type
  • vendor
fan
  • hw.status{hw.type="fan", state="degraded|failed|ok"}
  • hw.status{hw.type="fan", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • name
network
  • hw.network.bandwidth.limit
  • hw.network.up
  • hw.status{hw.type="network", state="degraded|failed|ok"}
  • hw.status{hw.type="network", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • name
  • physical_address
  • physical_address_type
other_device
  • hw.status{hw.type="other_device", state="degraded|failed|ok"}
  • hw.status{hw.type="other_device", state="present"}
  • device_type
  • hw.parent.id
  • hw.parent.type
  • id
  • name
physical_disk
  • hw.physical_disk.size
  • hw.status{hw.type="physical_disk", state="degraded|failed|ok"}
  • hw.status{hw.type="physical_disk", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • model
  • name
power_supply
  • hw.status{hw.type="power_supply", state="degraded|failed|ok"}
  • hw.status{hw.type="power_supply", state="present"}
  • hw.parent.id
  • hw.parent.type
  • id
  • info
  • name
  • power_supply_type
temperature
  • hw.status{hw.type="temperature", state="degraded|failed|ok"}
  • hw.status{hw.type="temperature", state="present"}
  • hw.temperature
  • hw.temperature.limit{limit_type="high.critical"}
  • hw.temperature.limit{limit_type="high.degraded"}
  • hw.parent.id
  • hw.parent.type
  • id
  • name
No results.