Back to the list of connectors

Pure Storage FA Series (REST Token Authentication)

Description

This connector discovers the environmental, 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, and must be provided the token in the password.

Connector ID: PureStorageRESTToken

This connector supersedes:

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

hws HOSTNAME -t storage -f PureStorageRESTToken --https --http-port 443 -u USERNAME

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: storage
  selectedConnectors: [ PureStorageRESTToken ] # Optional, to load only this connector
  http:
    https: true
    port: 443 # or probably something else
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-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:
      EmbeddedFile(1)
    • Request Body:
      {"api_token": "%{PASSWORD}"}
    • The entire response (header + body) contains: session (regex)

Metrics

Type Collected Metrics Specific Attributes (Labels)
Enclosure
  • hw.status{hw.type="enclosure",state="ok|degraded|failed"}
  • hw.status{hw.type="enclosure",state="present"}
  • model
  • serial_number
  • type
  • vendor
Blade
  • hw.status{hw.type="blade",state="ok|degraded|failed"}
  • hw.status{hw.type="blade",state="present"}
  • info
  • model
  • blade_name
  • serial_number
Fan
  • hw.status{hw.type="fan",state="ok|degraded|failed"}
  • hw.status{hw.type="fan",state="present"}
    Network Card, FC Port
    • hw.network.bandwidth.limit
    • hw.network.up
    • hw.status{hw.type="network",state="ok|degraded|failed"}
    • hw.status{hw.type="network",state="present"}
    • physical_address
    Other Device
    • hw.status{hw.type="other_device",state="ok|degraded|failed"}
    • hw.status{hw.type="other_device",state="present"}
    • device_type
    Physical Disk
    • hw.physical_disk.size
    • hw.status{hw.type="physical_disk",state="ok|degraded|failed"}
    • hw.status{hw.type="physical_disk",state="present"}
    • model
    Power Supply
    • hw.status{hw.type="power_supply",state="ok|degraded|failed"}
    • hw.status{hw.type="power_supply",state="present"}
    • info
    • power_supply_type
    Temperature Sensor
    • hw.status{hw.type="temperature",state="ok|degraded|failed"}
    • hw.status{hw.type="temperature",state="present"}
    • hw.temperature
      No results.