Pure Storage Link Aggregation Groups API

openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Link Aggregation Groups 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: Link Aggregation Groups
  description: Manages the link aggregation group (LAG) of Ethernet ports on the array.
paths:
  /api/2.26/link-aggregation-groups:
    get:
      tags:
      - Link Aggregation Groups
      summary: Pure Storage GET Link-aggregation-groups
      description: List the status and attributes of the Ethernet ports in the configured link aggregation groups.
      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'
      - $ref: '#/components/parameters/Sort'
      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/LinkAggregationGroupGetResponse'
    post:
      tags:
      - Link Aggregation Groups
      summary: Pure Storage POST Link-aggregation-groups
      description: Create a link aggregation group of Ethernet ports on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkAggregationGroup'
        required: true
        x-codegen-request-body-name: link-aggregation-group
      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/LinkAggregationGroupResponse'
      x-codegen-request-body-name: link-aggregation-group
    delete:
      tags:
      - Link Aggregation Groups
      summary: Pure Storage DELETE Link-aggregation-groups
      description: Remove a link aggregation group to unbind the ports.
      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:
      - Link Aggregation Groups
      summary: Pure Storage PATCH Link-aggregation-groups
      description: Modify link aggregation groups by adding and removing Ethernet ports.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkAggregationGroupPatch'
        required: true
        x-codegen-request-body-name: link-aggregation-group
      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/LinkAggregationGroupResponse'
      x-codegen-request-body-name: link-aggregation-group
components:
  parameters:
    Ids:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `ids`, then an error is returned.

        This cannot be provided together with the `name` or `names` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Continuation_token:
      name: continuation_token
      in: query
      description: 'A token used to retrieve the next page of data

        with some consistency guaranteed.

        The token is a Base64 encoded value.

        Set `continuation_token` to the system-generated token taken from the `x-next-token`

        header field of the response.

        A query has reached its last page when the response does not include a token.

        Pagination requires the `limit` and `continuation_token`

        query parameters.

        '
      schema:
        type: string
    Offset:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Names:
      name: names
      in: query
      description: 'Performs the operation on the unique names specified.

        Enter multiple names in comma-separated format.

        For example, `name01,name02`.


        If there is not at least one resource that matches

        each of the elements of `names`, then an error is returned,

        except when creating new resources.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Names_required:
      name: names
      in: query
      description: 'A comma-separated list of resource names.

        '
      required: true
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: 'Limits the size of the response to the specified number of objects on each page.

        To return the total number of resources, set `limit=0`.

        The total number of resources is returned as a `total_item_count` value.

        If the page size requested is larger than the system maximum limit,

        the server returns the maximum limit, disregarding the requested page size.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Sort:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        NOTE: If you provide a sort you will not get a `continuation_token` in

        the response.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
  schemas:
    _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
    LinkAggregationGroupPatch:
      type: object
      properties:
        add_ports:
          type: array
          items:
            $ref: '#/components/schemas/_reference'
        ports:
          type: array
          items:
            $ref: '#/components/schemas/_reference'
        remove_ports:
          type: array
          items:
            $ref: '#/components/schemas/_reference'
    LinkAggregationGroupResponse:
      type: object
      properties:
        items:
          description: A list of lag objects.
          type: array
          items:
            $ref: '#/components/schemas/LinkAggregationGroup'
    LinkAggregationGroupGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/LinkAggregationGroupResponse'
    PageInfo:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token` query

            param to get the next page of data.

            If you use the `continuation_token` to page through data you

            are guaranteed to get all items exactly once regardless of

            how items are modified. If an item is added or deleted during

            the pagination then it may or may not be returned.

            The `continuation_token` is generated if the `limit` is less

            than the remaining number of items, and the default sort is used

            (no sort is specified).

            '
          type: string
        total_item_count:
          description: Total number of items after applying `filter` params.
          type: integer
          format: int32
    _reference:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
        name:
          description: 'The resource name,

            such as volume name, pod name, snapshot name, and so on.

            '
          type: string
        resource_type:
          description: 'Type of the object (full name of the endpoint).

            Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`,

            `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`,

            `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and

            `policies/snapshot`, etc.

            '
          type: string
          readOnly: true
      x-aliases:
      - _referenceWithFixedType
    LinkAggregationGroup:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - description: 'Configuration information for a combination of physical ports grouped

          together into an aggregated-port.

          '
        type: object
        properties:
          lag_speed:
            description: 'Combined speed of all ports in the LAG in bits-per-second.

              '
            type: integer
            format: int64
            readOnly: true
            example: 260000000000
          mac_address:
            description: Unique MAC address assigned to the LAG.
            type: string
            pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
            readOnly: true
            example: 24:a9:37:11:f5:21
          port_speed:
            description: Configured speed of each port in the LAG in bits-per-second.
            type: integer
            format: int64
            readOnly: true
            example: 10000000000
          ports:
            description: Ports associated with the LAG.
            type: array
            items:
              $ref: '#/components/schemas/_reference'
          status:
            description: 'Health status of the LAG.

              Valid values are `critical`, `healthy`, `identifying`, `unclaimed`,

              `unhealthy`, `unrecognized`, and `unused`.

              '
            type: string
            readOnly: true
            example: healthy