VAST Data nvrams API

openapi: 3.0.3
info:
  description: VAST Management API definition
  title: VAST API Swagger Schema activedirectory nvrams API
  version: '1.0'
security:
- ApiToken: []
tags:
- description: NVRAMs represent flash SSDs resident in DBoxes that are deployed as SCM devices, formerly known as NVRAM devices.
  name: nvrams
paths:
  /nvrams/:
    get:
      description: This endpoint lists NVRAMs.
      operationId: nvrams_list
      parameters:
      - in: query
        name: page
        schema:
          type: string
      - description: Filter by NVRAM state
        in: query
        name: state
        schema:
          enum:
          - UNKNOWN
          - HEALTHY
          - FAILED
          - LOGIN_FAILED
          - ACTIVATING
          - INACTIVE
          - DEACTIVATING
          - FAILING
          - PHASING_OUT
          - ENTER_PHASING_OUT
          - EXIT_PHASING_OUT
          - ACTIVE
          type: string
      - description: Filter by NVRAM serial number
        in: query
        name: sn
        schema:
          type: string
      - description: Filter by NVRAM model
        in: query
        name: model
        schema:
          type: string
      - description: Filter by parent DBox name
        in: query
        name: dbox__name
        schema:
          type: string
      - description: Filter by parent DBox ID
        in: query
        name: dbox__id
        schema:
          type: string
      - description: Filter by NVRAM firmware version
        in: query
        name: fw_version
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NVRAM'
                title: NVRAMs
                type: array
          description: NVRAM information
      summary: List NVRAMs
      tags:
      - nvrams
  /nvrams/{id}/:
    get:
      description: This endpoint returns information about an NVRAM.
      operationId: nvrams_read
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NVRAM'
          description: ''
      summary: Return Details of an NVRAM
      tags:
      - nvrams
    patch:
      description: This endpoint activates or deactivates an NVRAM.
      operationId: nvrams_partial_update
      parameters:
      - description: NVRAM ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                enabled:
                  description: True for activate, False for deactivate
                  type: boolean
              type: object
        x-originalParamName: NVRAMModifyParams
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskInResponse'
          description: ''
      summary: Activate or Deactivate an NVRAM
      tags:
      - nvrams
  /nvrams/{id}/control_led/:
    patch:
      description: This endpoint controls the ON/OFF state of the specified SCM SLED's identification LED
      operationId: nvram_control_led
      parameters:
      - description: NVRAM / SCM ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                control:
                  description: LED state
                  enum:
                  - true
                  - false
                  type: string
              type: object
        x-originalParamName: NvramControlLed
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskInResponse'
          description: ''
      summary: Turn SCM SLED identification LED on and off
      tags:
      - nvrams
  /nvrams/{id}/format/:
    patch:
      description: This endpoint formats the NVRAM.
      operationId: nvram_format
      parameters:
      - description: NVRAM ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskInResponse'
          description: ''
      summary: Format NVRAM
      tags:
      - nvrams
components:
  schemas:
    NVRAM:
      properties:
        arch_type:
          type: string
        attached_dnode_names:
          description: Attached DNodes
          type: string
        carrier:
          description: The carrier number ssd resides in
          type: integer
          x-cli-header: Carrier-Index
        carrier_hw_version:
          type: string
        carrier_serial:
          type: string
        carrier_sw_version:
          type: string
        cluster:
          description: Parent Cluster
          type: string
        cluster_id:
          type: integer
        dbox:
          description: Parent DBox name
          type: string
          x-cli-header: DBox
        dbox_id:
          type: integer
        display_name:
          type: string
        dnode1_attached:
          type: boolean
        dnode2_attached:
          type: boolean
        enabled:
          description: SCM enabled
          type: boolean
        fail_reason:
          description: NVRAM failure reason
          enum:
          - NONE
          - IO_ERROR
          - DETACHED
          - FAILURE_DOMAIN_CHANGED
          - TEST_FAILED
          - SYSTEM_MISMATCH
          - DNODE_FAILURE
          - LOCKING_FAILED
          - CARRIER_VERSION_MISMATCH
          - FW_VERSION_MISMATCH
          - FAILED_CONNECT
          - HEALTH_CHECK_ERROR
          - TEMPERATURE_EXCEEDED_THRESHOLD
          - WRONG_DEVICE_LINK_PROPERTIES
          - INVALID_CARRIER_SERIAL
          type: string
          x-cli-header: Failure-Reason
        fw_version:
          description: SCM firmware version
          type: string
          x-cli-header: Firmware-Version
        guid:
          description: Global unique ID
          type: string
        id:
          description: ID
          type: integer
          x-cli-header: ID
        insertion_time:
          format: date-time
          type: string
          x-format: datetime2display
        is_remote:
          description: SCM is remote
          type: boolean
          x-cli-header: Remote
        led_status:
          type: string
          x-cli-header: Slot LED Status
        model:
          description: SCM model
          type: string
        name:
          type: string
          x-cli-header: Name
        phase_out:
          description: SCM phase out
          type: boolean
        shelf:
          description: The shelf
          enum:
          - FRONT
          - REAR
          - LEFT
          - RIGHT
          type: string
        size:
          description: Total SCM space
          format: int64
          type: integer
          x-cli-header: Total-Space
          x-display-base-type: capacity
          x-display-units: TB
          x-display-units-alt: TiB
          x-format: bytes2tb
        slot:
          description: SCM slot
          type: integer
        sn:
          description: SCM serial number
          type: string
          x-cli-header: Serial-Number
        space_in_use:
          description: SSD space in use
          format: int64
          type: integer
          x-cli-header: Space-In-Use
          x-display-base-type: capacity
          x-display-units: TB
          x-display-units-alt: TiB
        state:
          description: SCM state
          enum:
          - UNKNOWN
          - HEALTHY
          - FAILED
          - LOGIN_FAILED
          - ACTIVATING
          - INACTIVE
          - DEACTIVATING
          - FAILING
          - PHASING_OUT
          - ENTER_PHASING_OUT
          - EXIT_PHASING_OUT
          - ACTIVE
          type: string
        title:
          type: string
      type: object
    AsyncTaskInResponse:
      properties:
        async_task:
          description: Creation Async task properties
          type: object
      type: object
  securitySchemes:
    ApiToken:
      description: Send current valid API token in an Authorization header with format Api-Token <token>.
      in: header
      name: ApiToken
      type: apiKey
    basicAuth:
      description: Basic authentication using VMS user name and password
      scheme: basic
      type: http