Pure Storage Network Interfaces API

Manages the interfaces and the network connection attributes of the array.

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-array-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-volume-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-file-system-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-bucket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-array-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-file-system-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-bucket-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/pure1-cloud-api-array-structure.json

Other Resources

🔗
SDKs
https://pypi.org/project/py-pure-client/
🔗
SDKs
https://github.com/PureStorage-OpenConnect/PureStorage.Pure1
🔗
SDKs
https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
🔗
SDKs
https://github.com/PureStorage-OpenConnect/rest-client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/terraform-provider-flash
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flasharray-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-volume-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-array-example.json
🔗
SDKs
https://github.com/PureStorage-OpenConnect/flashblade-powershell
🔗
SDKs
https://github.com/purestorage/purity_fb_python_client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter
🔗
Tools
https://github.com/PureStorage-OpenConnect/flashblade-mcp-server
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flashblade-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-file-system-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-bucket-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-pure1-cloud-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/pure1-cloud-api-array-example.json

OpenAPI Specification

pure-storage-network-interfaces-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Network Interfaces API
  version: '2.52'
  description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos

    or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by

    mapping identities across the NFS and SMB protocols by using LDAP queries.

    '
servers:
- url: /
tags:
- name: Network Interfaces
  description: 'Manages the interfaces and the network connection attributes of the array.

    '
paths:
  /api/2.52/network-interfaces:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Interfaces
      description: Displays all network interfaces for all controllers on the array.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceGetResponse'
    post:
      tags:
      - Network Interfaces
      summary: Pure Storage Create Network Interface
      description: Creates a network interface on a controller on the array.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterfacePost'
        required: true
        x-codegen-request-body-name: network
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResponse'
      x-codegen-request-body-name: network
    delete:
      tags:
      - Network Interfaces
      summary: Pure Storage Delete Network Interface
      description: Deletes a network interface on a controller.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Network Interfaces
      summary: Pure Storage Modify Network Interface
      description: Modifies a network interface on a controller.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterfacePatch'
        required: true
        x-codegen-request-body-name: network
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResponse'
      x-codegen-request-body-name: network
  /api/2.52/network-interfaces/neighbors:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Interface Neighbors
      description: Displays all neighbors for all network interfaces on the array.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_port_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceNeighborGetResponse'
  /api/2.52/network-interfaces/performance:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Performance Statistics
      description: 'Displays network statistics, historical bandwidth, and error reporting for all

        specified network interfaces.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacePerformanceGetResponse'
  /api/2.52/network-interfaces/port-details:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List SFP Port Details
      description: 'Displays Ethernet and Fibre Channel SFP details.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesPortDetailsGetResponse'
  /api/2.26/network-interfaces:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces
      description: List network interfaces and their attributes.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceGetResponse_2'
    post:
      tags:
      - Network Interfaces
      summary: Pure Storage POST Network-interfaces
      description: Create a VIP to export data or perform replication.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterface_2'
        required: true
        x-codegen-request-body-name: network-interface
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResponse_2'
      x-codegen-request-body-name: network-interface
    delete:
      tags:
      - Network Interfaces
      summary: Pure Storage DELETE Network-interfaces
      description: Remove a VIP. Once a data VIP is removed, any clients connected through the data VIP will lose their connection to the file system or bucket.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
    patch:
      tags:
      - Network Interfaces
      summary: Pure Storage PATCH Network-interfaces
      description: Modify the attributes of a VIP.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkInterfacePatch_2'
        required: true
        x-codegen-request-body-name: network-interface
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceResponse_2'
      x-codegen-request-body-name: network-interface
  /api/2.26/network-interfaces/ping:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/ping
      description: 'Display network interface ping result.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ping_trace_component'
      - $ref: '#/components/parameters/Ping_count'
      - $ref: '#/components/parameters/Ping_trace_destination'
      - $ref: '#/components/parameters/Packet_size'
      - $ref: '#/components/parameters/Print_latency'
      - $ref: '#/components/parameters/Resolve_hostname'
      - $ref: '#/components/parameters/Ping_trace_source'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacePingGetResponse'
  /api/2.26/network-interfaces/trace:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/trace
      description: 'Display network interface trace result.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ping_trace_component'
      - $ref: '#/components/parameters/Ping_trace_destination'
      - $ref: '#/components/parameters/Mtu'
      - $ref: '#/components/parameters/Fragment_packet'
      - $ref: '#/components/parameters/Method'
      - $ref: '#/components/parameters/Port'
      - $ref: '#/components/parameters/Resolve_hostname'
      - $ref: '#/components/parameters/Ping_trace_source'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceTraceGetResponse'
  /api/2.26/network-interfaces/connectors:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/connectors
      description: List network connector information
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesConnectorsGetResponse'
    patch:
      tags:
      - Network Interfaces
      summary: Pure Storage PATCH Network-interfaces/connectors
      description: Modify network connector information.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HardwareConnector'
        required: true
        x-codegen-request-body-name: network-connector
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesConnectorsResponse'
      x-codegen-request-body-name: network-connector
  /api/2.26/network-interfaces/connectors/performance:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network Connectors Performance Statistics
      description: 'Displays network statistics, historical bandwidth, and error reporting for

        all specified network connectors.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/End_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Resolution'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Start_time'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformanceGetResponse'
  /api/2.26/network-interfaces/connectors/settings:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Global Network Settings for Network Connectors
      description: Display the global network settings for network connectors.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingsGetResponse'
  /api/2.26/network-interfaces/network-connection-statistics:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage GET Network-interfaces/network-connection-statistics
      description: 'Display network interface status

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsCurrent_state'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_host'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_port'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_host'
      - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_port'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkConnectionStatisticsGetResponse'
  /api/2.26/network-interfaces/neighbors:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage List Network Interface Neighbors
      description: Displays all neighbors for all network interfaces on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Local_port_names_2'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceNeighborGetResponse'
  /api/1.5/network-interfaces:
    get:
      tags:
      - Network Interfaces
      summary: Pure Storage Get Network Interfaces
      description: 'Retrieves information about physical and virtual network interface objects.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Names_2'
      - $ref: '#/components/parameters/Offset_3'
      - $ref: '#/components/parameters/Sort_3'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
            X-RateLimit-Remaining-second:
              description: 'The number of requests remaining for the organization in that second.

                '
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: 'The number of requests remaining for the organization in that minute.

                '
              schema:
                type: integer
            X-RateLimit-Limit-second:
              description: The number of requests available per second.
              schema:
                type: integer
            X-RateLimit-Limit-minute:
              description: The number of requests available per minute.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInterfaceGetResponse_3'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    NetworkInterfacePerformance:
      allOf:
      - $ref: '#/components/schemas/_resourceNoId'
      - type: object
        properties:
          eth:
            title: NetworkInterfacePerformanceEth
            allOf:
            - $ref: '#/components/schemas/_networkInterfacePerformanceEth'
          fc:
            title: NetworkInterfacePerformanceFc
            allOf:
            - $ref: '#/components/schemas/_networkInterfacePerformanceFc'
          interface_type:
            description: 'The interface type. Valid values are `eth` and `fc`.

              '
            type: string
            readOnly: true
          time:
            description: 'Sample time in milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            readOnly: true
        x-readOnly: true
    NetworkInterfaceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/NetworkInterfaceResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    HardwareConnector:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - type: object
        properties:
          connector_type:
            description: 'Form-factor of the interface.

              Valid values include QSFP, QSFP+, QSFP28, QSFP56, QSFP-DD, RJ-45, and -.

              '
            type: string
            readOnly: true
            example: QSFP
          lane_speed:
            description: 'Configured speed of each lane in the connector in bits-per-second.

              '
            type: integer
            format: int64
            example: 10000000000
          lanes_per_port:
            description: Configured number of lanes comprising each port in the connector.
            type: integer
            format: int64
            example: 4
          port_count:
            description: 'Configured number of ports in the connector (1/2/4 for QSFP).

              '
            type: integer
            format: int64
            example: 1
          port_speed:
            description: Configured speed of each port in the connector in bits-per-second.
            type: integer
            format: int64
            example: 40000000000
          transceiver_type:
            description: 'Details about the transceiver which is plugged into the connector port.

              Transceiver type will be read-only for pureuser. If nothing is plugged

              into QSFP port, value will be `Unused` and type cannot be auto-detected,

              and internal user has not specified a type - value will be `Unknown`.

              If transceiver is plugged in, and type is auto-detected, and/or type

              has been explicitly set by internal user - that value will be shown.

              Transceiver type is not applicable for RJ-45 connectors.

              '
            type: string
            readOnly: true
            example: 40GBASE-LR4
    _networkInterfacePortDetailsTx_power:
      type: object
      properties:
        channel:
          description: 'The channel number if the transceiver is a multilane transceiver.

            If not specified, defaults to `null`.

            '
          type: integer
          example: 0
        measurement:
          description: 'Tx output power in mW.

            '
          type: number
          format: double
        status:
          description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning,

            or low warning thresholds for Tx output power.

            Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`.

            '
          type: string
          example: ok
    _networkInterfacePortDetailsVoltage:
      type: object
      properties:
        channel:
          description: 'The channel number if the diagnostic has an associated channel number.

            If not specified, defaults to `null`.

            '
          type: integer
          example: 0
        measurement:
          description: 'Supply voltage in volts.

            '
          type: number
          format: double
        status:
          description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning,

            or low warning thresholds for supply voltage.

            Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`.

            '
          type: string
          example: ok
    _timeAware:
      type: object
      properties:
        _as_of:
          description: The freshness of the data (timestamp in millis since epoch).
          type: integer
          format: int64
          readOnly: true
          example: 1502729489760
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    NetworkInterface_3:
      allOf:
      - $ref: '#/components/schemas/_arraysBuiltIn'
      - description: 'A point of interconnection between the appliance and a private or public

          network. May be associated with a physical device or a representation of

          a virtual interface.

          '
        type: object
        properties:
          address:
            description: IP address of this network interface.
            type: string
            example: 10.11.12.13
          enabled:
            type: boolean
            example: true
          gateway:
            type: string
            example: 10.20.30.40
          hwaddr:
            description: Hardware address.
            type: string
            example: 90:ef:ba:80:70:dc
          mtu:
            description: Maximum transmission unit.
            type: integer
            format: int32
            example: 9000
          netmask:
            type: string
            example: 255.255.255.0
          services:
            description: Services and protocols that are enabled on the interface.
            type: array
            items:
              type: string
              description: "Valid values are `iscsi`, `management`, `nvme/fc`, `nvme/roce`,\n  and `replication`.\n"
              example: iscsi
          speed:
            description: Speed in bytes per second.
            type: integer
            format: int64
            example: 10000000000
          subinterfaces:
            type: array
            items:
              type: string
              example: ct0.eth0
    NetworkInterfaceTraceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/NetworkInterfaceTraceResponse'
    NetworkInterfaceResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface'
    NetworkInterfacePatch:
      type: object
      properties:
        attached_servers:
          description: 'Applicable only to Ethernet interfaces.

            List of servers to be associated with the specified network interface for data ingress.

            At most one server can be specified for each interface. To attach the network

            interface to a server, `name` or `id` the desired server must be provided. To detach

            a network interface from all servers, an empty list `[]` should be passed to the

            `attached_servers` field.

            '
          type: array
          maxItems: 1
          items:
            $ref: '#/components/schemas/_reference'
        enabled:
          description: 'Returns a value of `true` if the specified network interface or Fibre Channel port is

            enabled. Returns a value of `false` if the specified network interface or Fibre Channel

            port is disabled.

            '
          type: boolean
        eth:
          $ref: '#/components/schemas/_networkinterfacepatchEth'
        override_npiv_check:
          description: 'N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports

            configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port

            configured for SCSI might cause the NPIV status to change from enabled to disabled or

            vice versa. Set this option to proceed with enabling or disabling the port.

            '
          type: boolean
        services:
          description: 'The services provided by the specified network interface or Fibre Channel port.

            '
          type: array
          items:
            type: string
            description: 'Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`,

              `nvme-tcp`, `offload`, `replication`, and `scsi-fc`.

              '
    _networkInterfaceNeighborNeighborPortId:
      description: 'An administratively assigned identifier of the particular neighboring port.

        '
      type: object
      properties:
        type:
          description: 'The port ID subtype. Valid values are `ifname`, `ifalias`, `local`, `mac`, `ip`, and

            `unhandled`.

            '
          type: string
          example: ifname
        value:
          description: The specific identifier for the particular port.
          type: string
          example: Ethernet7
    NetworkInterfacesPortDetailsGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/NetworkInterfacesPortDetailsResponse'
    NetworkInterfaceResponse_3:
      type: object
      properties:
        items:
          description: A list of network interface objects.
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface_3'
    _builtIn:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
        name:
          description: Name of the object (e.g., a file system or snapshot).
          type: string
          readOnly: true
    _builtInAsOf:
      description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support

        settings). Some correspond to a piece of software, like an app, or hardware,

        like a controller. Others are created by the system in response to some event

        (e.g., alerts, audit records).


        Typically, a user can''t create, delete or rename a built-in resource. A few

        can be created or deleted, but not renamed because the names are meaningful

        to Purity (e.g., VIFs).


        '
      allOf:
      - $ref: '#/components/schemas/_timeAware'
      - type: object
        properties:
          id:
            description: A non-modifiable, globally unique ID chosen by the system.
            type: string
            readOnly: true
            example: 01c2889a-4124-49ff-8cbd-c33405ede123
          name:
            description: A non-modifiable, locally unique name chosen by the system.
            type: string
            readOnly: true
            example: example_name
    NetworkInterfaceNeighborResponse:
      type: object
      

# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-network-interfaces-api-openapi.yml