openapi: 3.2.0
info:
  title: Nasuni Filers API
  version: '1.0'
  description: 'Operations tagged Filers across 3 of this provider''s published API definitions: nasuni-nmc-v1-0-openapi.yml, nasuni-nmc-v1-1-openapi.yml, nasuni-nmc-v1-2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://hostname/api/v1
- url: https://hostname/api/v1.1
- url: https://hostname/api/v1.2
security:
- AuthToken: []
tags:
- name: Filers
paths:
  /filers/:
    get:
      tags:
      - Filers
      summary: List all Filers
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - Return status and configuration for all managed Filers.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/Filer'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: The reason why the agent couldn't be authorized.
                    enum:
                    - Authentication credentials were not provided.
                    - Invalid token.
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/{filer_serial}/:
    get:
      tags:
      - Filers
      summary: Get a Filer
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Return status and configuration for the specified managed Filer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filer'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      tags:
      - Filers
      summary: Update a Filer
      description: Update the Filer's settings with the given body.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Filer_2'
        required: true
      responses:
        '202':
          description: Accepted - Filer has been sent a message
          headers:
            Location:
              description: URL to the associated message
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '405':
          description: Method not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codegen-request-body-name: body
    servers:
    - url: https://hostname/api/v1
  /filers/cifsclients/:
    get:
      tags:
      - Filers
      summary: Retrieve a list of all Filers, each with a list of CIFS clients connected to it.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - Return a list of Filers with lists of their CIFS clients
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerCIFSClients'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/{filer_serial}/cifsclients/:
    get:
      tags:
      - Filers
      summary: Retrieve a Filer with a list of CIFS clients connected to it.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Return the specified Filer with a list of its CIFS clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilerCIFSClients'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/cifslocks/:
    get:
      tags:
      - Filers
      summary: Retrieve a list of all Filers, each with a list of CIFS file locks that clients have on its shares.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - Return a list of Filers with lists of their CIFS file locks
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerCIFSLocks'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/{filer_serial}/cifslocks/:
    get:
      tags:
      - Filers
      summary: Retrieve a Filer with a list of CIFS file locks that clients have on its shares.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Return the specified Filer with a list of its CIFS file locks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilerCIFSLocks'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/ftpclients/:
    get:
      tags:
      - Filers
      summary: Retrieve a list of all Filers, each with a list of FTP clients connected to it.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - Return a list of Filers with lists of their FTP clients
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerFTPClients'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/{filer_serial}/ftpclients/:
    get:
      tags:
      - Filers
      summary: Retrieve a Filer with a list of FTP clients connected to it.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Return the specified Filer with a list of its FTP clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilerFTPClients'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://hostname/api/v1
  /filers/amqp-audit-destinations/:
    get:
      tags:
      - Filers
      summary: List AMQP Destinations
      description: Only available with Filers on version 8.5 and higher.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - List of all AMQP Destination across all Filers
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/AMQPAuditDestination'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/amqp-audit-destinations/:
    get:
      tags:
      - Filers
      summary: List AMQP Destinations for a Filer
      description: Only available with Filers on version 8.5 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - List of AMQP Destinations on a specific Filer
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/AMQPAuditDestination'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Filers
      summary: Create an AMQP Destination
      description: Only available with Filers on version 8.5 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
              - $ref: '#/components/schemas/AMQPAuditDestination'
        required: true
      responses:
        '202':
          description: Accepted - Filer has been sent a message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codegen-request-body-name: body
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/amqp-audit-destinations/{amqp_destination_name}:
    get:
      tags:
      - Filers
      summary: Get a single AMQP destination
      description: Only available with Filers on version 8.5 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: amqp_destination_name
        in: path
        description: AMQP Destination name (URL-encoded)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Information about the specified AMQP Destination
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AMQPAuditDestination'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Filers
      summary: Delete an AMQP destination
      description: Only available with Filers on version 8.5 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: amqp_destination_name
        in: path
        description: AMQP Destination name (URL-encoded)
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted - Filer has been sent a message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
      - Filers
      summary: Update an AMQP destination
      description: Only available with Filers on version 8.5 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: amqp_destination_name
        in: path
        description: AMQP Destination name (URL-encoded)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AMQPAuditDestination'
        required: true
      responses:
        '202':
          description: Accepted - Filer has been sent a message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codegen-request-body-name: body
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/cifsclients/{cifs_client_id}:
    get:
      tags:
      - Filers
      summary: Get CIFS client
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: cifs_client_id
        in: path
        description: CIFS client object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Information about the specified CIFS client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilerCIFSClient'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/cifsclients/locks/:
    get:
      tags:
      - Filers
      summary: List CIFS file locks
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - List of all CIFS file locks across all Filers
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerCIFSLock'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/cifsclients/locks/:
    get:
      tags:
      - Filers
      summary: List CIFS file locks for a Filer
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - List of CIFS file locks held by clients of the specified Filer
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerCIFSLock'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/cifsclients/{cifs_client_id}/locks/:
    get:
      tags:
      - Filers
      summary: List CIFS file locks for a client
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: cifs_client_id
        in: path
        description: CIFS client object identifier
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: OK - List of CIFS file locks held by the specified client
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerCIFSLock'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/ftpclients/{ftp_client_id}:
    get:
      tags:
      - Filers
      summary: Get FTP client
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: ftp_client_id
        in: path
        description: FTP client object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK - Description of the specified FTP client
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilerFTPClient'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/encryption-keys/:
    get:
      tags:
      - Filers
      summary: List encryption keys
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/EncryptionKey'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/encryption-keys/:
    get:
      tags:
      - Filers
      summary: List encryption keys for a Filer
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/EncryptionKey'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Filers
      summary: Upload encryption keys for a Filer
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              required:
              - key_file
              type: object
              properties:
                key_file:
                  type: string
                  format: binary
                  description: A GPG key file
                passphrase:
                  type: string
                  description: Passphrase for the key file
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/encryption-keys/{encryption_key_id}/:
    get:
      tags:
      - Filers
      summary: Get a Filer encryption key
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: encryption_key_id
        in: path
        description: Encryption key object identifier
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncryptionKey'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/health/:
    get:
      tags:
      - Filers
      summary: List health status for all Filers
      description: Only available with Filers on version 8.8 and higher.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerHealthStatus'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/{filer_serial}/health/:
    get:
      tags:
      - Filers
      summary: List health status for a Filer
      description: Only available with Filers on version 8.8 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/FilerHealthStatus'
                - $ref: '#/components/schemas/Paging'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://hostname/api/v1.1
  /filers/blocked-clients/:
    get:
      tags:
      - Filers
      summary: List blocked clients across all Filers
      description: Only available with Filers on version 9.9 and higher and NMCs on version 22.3 and higher.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/Paging_2'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlockedClient'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/{filer_serial}/blocked-clients/:
    get:
      tags:
      - Filers
      summary: List blocked clients on a Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 22.3 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/Paging_2'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlockedClient'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    post:
      tags:
      - Filers
      summary: Block a client IP address on a Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 22.3 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ip_address:
                  type: string
                  description: IP address of the blocked client.
        required: true
      responses:
        '202':
          description: Accepted - Filer has been sent a message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/{filer_serial}/blocked-clients/{blocked_ip}/:
    get:
      tags:
      - Filers
      summary: Get specific blocked client on specific Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 22.3 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_ip
        in: path
        description: The index of the first object to return
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/BlockedClient'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    delete:
      tags:
      - Filers
      summary: Unblock a client IP address on a Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 22.3 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_ip
        in: path
        description: Blocked client IP
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '403':
          description: Permission Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/blocked-sources/ip-addresses/:
    get:
      tags:
      - Filers
      summary: List blocked IP addresses across all Filers
      description: Only available with Filers on version 9.9 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/Paging_2'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlockedSourceIpAddress'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/blocked-sources/usernames/:
    get:
      tags:
      - Filers
      summary: List blocked usernames across all Filers
      description: Only available with Filers on version 10.1 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: limit
        in: query
        description: The maximum number of objects to return
        schema:
          maximum: 100
          minimum: 1
          type: integer
          default: 50
      - name: offset
        in: query
        description: The index of the first object to return
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/Paging_2'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlockedSourceUsername'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/{filer_serial}/blocked-sources/ip-addresses/:
    get:
      tags:
      - Filers
      summary: List blocked IP addresses on a Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/Paging_2'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlockedSourceIpAddress'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/{filer_serial}/blocked-sources/usernames/:
    get:
      tags:
      - Filers
      summary: List blocked usernames on a Filer
      description: Only available with Filers on version 10.1 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/Paging_2'
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlockedSourceUsername'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/{filer_serial}/blocked-sources/ip-addresses/{blocked_ip}/:
    get:
      tags:
      - Filers
      summary: Get specific blocked IP address on specific Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_ip
        in: path
        description: The index of the first object to return
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/BlockedSourceIpAddress'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    put:
      tags:
      - Filers
      summary: Block an IP address on a Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_ip
        in: path
        description: The index of the first object to return
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted - Filer has been sent a message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    delete:
      tags:
      - Filers
      summary: Unblock an IP address on a Filer
      description: Only available with Filers on version 9.9 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_ip
        in: path
        description: Blocked IP address
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '403':
          description: Permission Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
  /filers/{filer_serial}/blocked-sources/usernames/{blocked_username}/:
    get:
      tags:
      - Filers
      summary: Get specific blocked username on specific Filer
      description: Only available with Filers on version 10.1 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_username
        in: path
        description: The index of the first object to return
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  Paging:
                    $ref: '#/components/schemas/BlockedSourceUsername'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    put:
      tags:
      - Filers
      summary: Block a username on a Filer
      description: Only available with Filers on version 10.1 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_username
        in: path
        description: The index of the first object to return
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted - Filer has been sent a message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    delete:
      tags:
      - Filers
      summary: Unblock a username on a Filer
      description: Only available with Filers on version 10.1 and higher and NMCs on version 25.2 and higher.
      parameters:
      - name: filer_serial
        in: path
        description: Filer object identifier
        required: true
        schema:
          type: string
      - name: blocked_username
        in: path
        description: Blocked username
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '403':
          description: Permission Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
        '429':
          description: Request throttled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse_2'
    servers:
    - url: https://hostname/api/v1.2
components:
  schemas:
    FilerFTPClients:
      type: object
      properties:
        serial_number:
          type: string
          description: Serial number of the Filer.
        description:
          type: string
          description: The Filer's description.
        ftp_clients:
          type: array
          items:
            type: object
            properties:
              user:
                type: string
                description: The username of the connected client.
              client:
                type: string
                description: The IP Address of the client machine.
              protocol:
                type: string
                description: The connection's protocol.
                enum:
                - ftp
                - sftp
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link'
            filer:
              $ref: '#/components/schemas/Link'
          description: Links to related resources, collections, and actions.
      description: A description of a Filer's connected FTP clients.
    Paging:
      type: object
      properties:
        href:
          type: string
          description: A link to the requested endpoint.
        limit:
          type: integer
          description: The maximum number of items in a page.
        next:
          type: string
          description: A link to the next page of objects. The value will be null if there isn't one.
        offset:
          type: integer
          description: The item number the page starts on.
        previous:
          type: string
          description: A link to the previous page of objects. The value will be null if there isn't one.
        total:
          type: integer
          description: Total number of items available at the requested endpoint.
      description: The paging object provides a container for a listing of objects, defining the start, end, and total size of the listing. Any endpoint that returns a list of items, will likely be wrapped in a paging object.
    FilerConfigurationQuotaReportSchedule:
      type: object
      properties:
        schedules:
          type: array
          items:
            type: object
            properties:
              days:
                type: object
                properties:
                  sun:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Sunday.
                  mon:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Monday.
                  tue:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Tuesday.
                  wed:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Wednesday.
                  thu:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Thursday.
                  fri:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Friday.
                  sat:
                    type: boolean
                    description: Whether the Filer runs automatic updates on Saturday.
                description: Set the days of the week on which the reports should be generated, at the hour specified in "activation_hour".
              activation_hour:
                type: integer
                description: Hour of the day to generate and send the quota report. An integer between 0 and 23, with 0 = '12 AM', 1 = '1 AM', ... 23 = '11 PM'.
              admin_report:
                type: boolean
                description: Set whether to generate the administrative report. This reports on all Directory Quota Violations, and is sent to the addresses set to receive email in Email Settings and Configurations.
              user_report:
                type: boolean
                description: Set whether to generate the user report. This reports on individual Directory Quota Violations and will be sent to the address specifed in the Quota or the owner of the directory, if available (CIFS/AD mode only).
              threshold:
                type: integer
                description: Report on Quotas where the usage is at or above the specified percent of the limit.
    Error:
      type: object
      properties:
        code:
          type: string
          description: 'Specifies the type of error reported. Possible values:


            * "error" - General error

            * "validation_error" - Validation error

            * "not_found_error" - Resource not found

            * "auth_error" - Authentication error

            * "perm_error" - Permission error

            * "sync_error" - Error occurred syncing settings with a Filer.

            * "throttled_error" - The request was throttled; too many sent within a duration.

            '
          enum:
          - error
          - validation_error
          - not_found_error
          - auth_error
          - perm_error
          - sync_error
          - throttled_error
        description:
          type: string
          description: Description of the error reported.
    FilerConfigurationAutoupdate:
      type: object
      properties:
        hour:
          type: integer
          description: Hour of the day to perform automatic updates. An integer between 0 and 23, with 0 = '12 AM', 1 = '1 AM', ... 23 = '11 PM'.
        sun:
          type: boolean
          description: Whether the Filer runs automatic updates on Sunday.
        mon:
          type: boolean
          description: Whether the Filer runs automatic updates on Monday.
        tue:
          type: boolean
          description: Whether the Filer runs automatic updates on Tuesday.
        wed:
          type: boolean
          description: Whether the Filer runs automatic updates on Wednesday.
        thu:
          type: boolean
          description: Whether the Filer runs automatic updates on Thursday.
        fri:
          type: boolean
          description: Whether the Filer runs automatic updates on Friday.
        sat:
          type: boolean
          description: Whether the Filer runs automatic updates on Saturday.
    FilerConfigurationFTP:
      type: object
      properties:
        masq_address:
          type: string
          description: Set the Masquerade address. This IP address is presented to the client instead of the local server's IP.
        idle_timeout:
          type: integer
          description: Set the amount of time (in seconds) that a user can stay connected while idle before being disconnected.
        anon_user:
          type: string
          description: 'Set the username a user must log in with in order to access FTP directories anonymously. This field is case sensitive. (default: anonymous)'
        anon_group:
          type: string
          description: 'Set the Group assigned to the Anonymous User for file permissions. Note: This does not give all members of this group anonymous access. (default: anonymous)'
        protocols:
          type: array
          description: Read only. List of FTP protocols supported by the Filer.
          items:
            type: string
    FilerConfigurationCIFS:
      type: object
      properties:
        aio_support:
          type: boolean
          description: Read only. Indicates whether Async IO is supported.
        deny_access:
          type: boolean
          description: Read only. Indicates whether denying a user access to a share is supported
        fruit_support:
          type: boolean
          description: Read only. Indicates whether Mac OS X Extensions are available.
        proto_level:
          type: string
          description: 'Read only. Indicates the CIFS protocol level of the Filer.


            * *SMB3* -- CIFS & SMB3 support.

            * *SMB2* -- CIFS & SMB2 support.

            * '''' -- CIFS support.

            '
          enum:
          - SMB3
          - SMB2
          - ''
        restrict_anonymous:
          type: boolean
          description: Set whether to restrict anonymous user access.
        roundup_size:
          type: string
          description: 'Set the Allocation roundup size.

            This rounds the file size on disk reported to clients. Disabled by

            default, this should only be enabled when the system is being

            accessed by older SMBv1 clients; otherwise, there may be a

            performance impact.

            May also affect file size reporting on some platforms.


            * `` - Allocation roundup size is 1 MiB (default value for Filers older than version 9.0).

            * `0` - Allocation roundup is disabled (default value for Filers version 9.0 and newer).

            * `1048576` - Allocation roundup size is 1 MiB.

            '
        smb3:
          type: boolean
          description: Read only. Indicates whether SMB3 is supported.
        smb_encrypt:
          type: boolean
          description: Read only. Indicates whether SMB Encryption is supported.
        unix_ext:
          type: boolean
          description: Set whether Enhanced Support for POSIX clients is enabled.
        veto_files:
          type: boolean
          description: Read only. Indicates whether blocking files is supported. This can be configured through Shares settings.
    FilerCIFSClients:
      type: object
      properties:
        serial_number:
          type: string
          description: Serial number of the Filer.
        description:
          type: string
          description: The Filer's description.
        cifs_clients:
          type: array
          items:
            type: object
            properties:
              share:
                type: string
                description: The name of the CIFS share that the client is connected to.
              user:
                type: string
                description: The username of the connected client.
              client:
                type: string
                description: The IP Address of the client machine.
              client_name:
                type: string
                description: The hostname of the connected client.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link'
            filer:
              $ref: '#/components/schemas/Link'
          description: Links to related resources, collections, and actions.
      description: A description of a Filer's connected CIFS clients.
    FilerServicesSupport:
      type: object
      properties:
        connected:
          type: boolean
          description: Read only. Indicates if Nasuni Support is currently connected for Remote Support.
        enabled:
          type: boolean
          description: Enable or disable Remote Support.
        running:
          type: boolean
          description: ''
        timeout:
          type: integer
          description: Set the timeout in seconds after which Remote Support is automatically disabled.
      description: Enable or disable Remote Support, set the timeout before it is automatically disabled, and report if there is an active connection from Nasuni Support.
    FilerServicesMobile:
      type: object
      properties:
        limit_single_device:
          type: boolean
          description: Set whether to restrict users to using a single mobile device. If true, each user account can only have one mobile device associated with it which is allowed to connect to Mobile Service. If false, each user account can have any number of mobile devices registered.
        additional_api_port:
          type: integer
          description: If set, allow access to Mobile service on the specified port. Set to a valid port number 1-65535. Set to null to disable.
        session_expiration_time:
          type: integer
          description: If set, users must reauthenticate after their session has expired. Enter a value in hours. If set to 0, the sessions never expire.
        allowed_devices:
          type: array
          items:
            type: string
            enum:
            - OSX
            - WINDOWS
            - IOS
            - LINUX
            - ANDROID
    FilerCIFSLocks:
      type: object
      properties:
        serial_number:
          type: string
          description: Serial number of the Filer.
        description:
          type: string
          description: The Filer's description.
        cifs_locks:
          type: array
          items:
            type: object
            properties:
              share:
                type: string
                description: The name of the CIFS share that this file lock is on.
              file_path:
                type: string
                description: The path to the locked file.
              type:
                type: string
                description: The type of lock.
              user:
                type: string
                description: The username of the connected client.
              client:
                type: string
                description: The IP Address of the client machine.
              client_name:
                type: string
                description: The hostname of the connected client.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link'
            filer:
              $ref: '#/components/schemas/Link'
          description: Links to related resources, collections, and actions.
      description: A description of the CIFS File Locks that CIFS clients have on this Filer's shares.
    FilerPlatform:
      type: object
      properties:
        platform_name:
          type: string
          description: A description of the hardware platform this Filer runs on.
        cpu:
          type: object
          properties:
            model:
              type: string
              description: Human-readable description of the CPU model.
            frequency:
              type: number
              description: CPU Frequency in MHz.
            sockets:
              type: integer
              description: Number of CPU sockets currently used on this Filer's platform.
            cores:
              type: integer
              description: Total number of CPU cores across all CPUs.
        memory:
          type: string
          description: A string representing an integer. The size in megabytes of the Filer's memory.
        cache_status:
          type: object
          properties:
            size:
              type: integer
              description: The size in bytes of the Filer's cache.
            used:
              type: integer
              description: The amount in bytes of the Filer's cache currently in use.
            dirty:
              type: integer
              description: The amount of data in bytes belonging to files currently marked as needing to be written to storage or re-read into the cache.
            free:
              type: integer
              description: The amount in bytes of the Filer's cache currently available.
            percent_used:
              type: number
              description: The percentage of the cache currently in use, i.e. used/size.
      description: Information about a Filer's platform, including hardware type and information about CPU, Memory, and cache.
    Link:
      type: object
      properties:
        href:
          type: string
          description: Hyperlink to the resource.
        method:
          type: string
          description: HTTP method to use on the link.
    Filer:
      type: object
      properties:
        build:
          type: string
          description: Current version and build number of the Filer's software.
        description:
          type: string
          description: The Filer's description.
        guid:
          type: string
          description: Unique identifier of the Filer instance.
        management_state:
          type: string
          description: 'Current NMC Management state of the Filer. Possible values:


            * ''self'' - Filer is NOT managed by NMC.

            * ''nmc'' -  Filer is managed by NMC.

            * ''pending_self'' - Filer is pending self management.

            * ''pending_nmc'' - Filer is pending NMC management.

            '
          enum:
          - self
          - nmc
          - pending_self
          - pending_nmc
        serial_number:
          type: string
          description: Serial number of the Filer.
        settings:
          type: object
          properties:
            alert_thresholds:
              type: object
              properties:
                cpu_alert_settings:
                  type: object
                  properties:
                    cpu_enabled:
                      type: boolean
                      description: If true, will enable alerts for CPU usage.
                    cpu_threshold:
                      type: integer
                      description: Percentage of CPU usage that can trigger an alert.
                    cpu_duration:
                      type: integer
                      description: Time in minutes that the system will allow CPU usage over the cpu_threshold before trigging an alert.
                  description: Configuration values for alerting on Filer CPU usage.
                memory_alert_settings:
                  type: object
                  properties:
                    memory_enabled:
                      type: boolean
                      description: If true, will enable alerts for memory usage.
                    memory_threshold:
                      type: integer
                      description: Percentage of memory usage that can trigger and alert.
                    memory_duration:
                      type: integer
                      description: Time in minutes that the system will allow memory usage over the memory_threshold before trigging an alert.
                  description: Configuration values for alerting on Filer memory usage.
                snapshot_alert_settings:
                  type: object
                  properties:
                    snapshot_enabled:
                      type: boolean
                      description: If true, will enable alerts for snapshots.
                    snapshot_duration:
                      type: integer
                      description: Time in hours to trigger an alert if a snapshot has not completed.
                  description: Configuration values for alerting on Snapshots.
              description: Filer system alert configuration.
            autoupdate:
              $ref: '#/components/schemas/FilerConfigurationAutoupdate'
            cache_reserved:
              type: object
              properties:
                reserved:
                  type: string
                  description: Set the percentage of the cache reserved for new, incoming data. A string representing a multiple-of-five integer between 5-90, or the string "unset" if the Filer automatically manages this.
                  enum:
                  - unset
                  - '5'
                  - '10'
                  - '15'
                  - '20'
                  - '25'
                  - '30'
                  - '35'
                  - '40'
                  - '45'
                  - '50'
                  - '55'
                  - '60'
                  - '65'
                  - '70'
                  - '75'
                  - '80'
                  - '85'
                  - '90'
                maxv:
                  type: integer
                  description: Read only. Maximum percentage of the cache reserved for new, incoming data.
                minv:
                  type: integer
                  description: Read only. Minimum percentage of the cache reserved for new, incoming data.
            cifs:
              $ref: '#/components/schemas/FilerConfigurationCIFS'
            ftp:
              $ref: '#/components/schemas/FilerConfigurationFTP'
            gl_settings:
              type: object
              properties:
                degrade_to_read_locks:
                  type: boolean
                  description: Set whether or not to degrade all locks to read locks. Enabling this feature will cause all locks that are not read locks to be denied. This feature should only be enabled if the lock server is not available for an extended period of time. This feature effectively makes any directories with global locks enabled read only.
              description: Settings that control certain aspects of Global Locking.
            mobile_service:
              $ref: '#/components/schemas/FilerServicesMobile'
            qos:
              type: object
              properties:
                rules:
                  type: array
                  description: QoS rules
                  items:
                    type: object
                    properties:
                      days:
                        type: object
                        properties:
                          mon:
                            type: boolean
                          tue:
                            type: boolean
                          wed:
                            type: boolean
                          thu:
                            type: boolean
                          fri:
                            type: boolean
                          sat:
                            type: boolean
                          sun:
                            type: boolean
                        description: Days of the week to apply the QoS rule.
                      start:
                        type: integer
                        description: Hour of the day (0-23) to start applying the QoS rule.
                      stop:
                        type: integer
                        description: Hour of the day (0-23) to stop applying the QoS rule.
                      limit:
                        type: integer
                        description: The maximum outbound data rate in bytes. Specify zero for no limit.
                      ingress_limit:
                        type: integer
                        description: The maximum inbound data rate in bytes. Specify zero for no limit.
              description: Quality of Service configuration.
            quota_report_schedule:
              $ref: '#/components/schemas/FilerConfigurationQuotaReportSchedule'
            remote_support:
              $ref: '#/components/schemas/FilerServicesSupport'
            snmp:
              type: object
              properties:
                v2_enabled:
                  type: boolean
                  description: If true, will enable v1,v2c support.
                v2_community:
                  type: string
                  description: 'SNMP Community name (ex: ''public'').

                    '
                v3_enabled:
                  type: boolean
                  description: If true, will enable v3 support.
                v3_username:
                  type: string
                  description: Username for SNMP v3 authentication.
                v3_password:
                  type: string
                  description: Password for SNMP v3 authentication. SHA authentication and optional privileged security using AES encryption are used to communicate to the SNMP agent. Will display a masked value of '*****' if a password exists, otherwise will be blank.
                sys_location:
                  type: string
                  description: 'SNMP System Location (ex: ''Boston Colo - Rack 1'').

                    '
                sys_contact:
                  type: string
                  description: 'SNMP system contact (ex: ''Support <support@example.com>'').

                    '
                trap_ips:
                  type: array
                  description: List of IPs or hostnames listening for SNMP traps. Leave blank if you wish not to listen for SNMP traps. Traps will be sent using SNMP v3 settings above and the Filer's unique engine id.
                  items:
                    type: string
                    description: IPs or hostnames listening for SNMP traps.
              description: Filer SNMP Settings
            time:
              type: object
              properties:
                ntpservers:
                  type: array
                  items:
                    type: string
                    description: A host running the Network Time Protocol (NTP).
                timezone:
                  type: string
                  description: Timezone of the Filer.
                current_time_utc:
                  type: string
                  description: Current time reported by the Filer. Last report time will only be updated periodically unless manually refreshed.
              description: Filer Time Configuration
          description: Settings that are associated with this Filer.
        status:
          type: object
          properties:
            offline:
              type: boolean
              description: If true, the Filer has not reported back to the NMC within the last hour.
            osversion:
              type: string
              description: The version of the Operating System running on this filer.
            platform:
              $ref: '#/components/schemas/FilerPlatform'
            updates:
              type: object
              properties:
                updates_available:
                  type: boolean
                  description: Indicates whether or not there are software updates available for the Filer.
                current_version:
                  type: string
                  description: The current version of the software running on this Filer.
                new_version:
                  type: string
                  description: If an update is available, this indicates the new version of the software which will be installed.
              description: Information about the current software version and the availability of updates.
            uptime:
              type: integer
              description: Uptime of this Filer, in seconds.
          description: Filer status.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link'
            cifsclients:
              $ref: '#/components/schemas/Link'
            cifslocks:
              $ref: '#/components/schemas/Link'
            ftpclients:
              $ref: '#/components/schemas/Link'
          description: Links to related resources, collections, and actions.
      description: Complete Filer object with all associated settings and statuses.
    FilerConfigurationAutoupdate_2:
      type: object
      properties:
        hour:
          type: integer
          description: Hour of the day to perform automatic updates. An integer between 0 and 23, with 0 = '12 AM', 1 = '1 AM', ... 23 = '11 PM'.
          readOnly: true
        sun:
          type: boolean
          description: Whether the Filer runs automatic updates on Sunday.
          readOnly: true
        mon:
          type: boolean
          description: Whether the Filer runs automatic updates on Monday.
          readOnly: true
        tue:
          type: boolean
          description: Whether the Filer runs automatic updates on Tuesday.
          readOnly: true
        wed:
          type: boolean
          description: Whether the Filer runs automatic updates on Wednesday.
          readOnly: true
        thu:
          type: boolean
          description: Whether the Filer runs automatic updates on Thursday.
          readOnly: true
        fri:
          type: boolean
          description: Whether the Filer runs automatic updates on Friday.
          readOnly: true
        sat:
          type: boolean
          description: Whether the Filer runs automatic updates on Saturday.
          readOnly: true
    HealthItem:
      type: string
      enum:
      - Healthy
      - Warning
      - Unhealthy
      - No Results
    FilerConfigurationQuotaReportSchedule_2:
      type: object
      properties:
        schedules:
          type: array
          items:
            type: object
            properties:
              days:
                type: object
                properties:
                  sun:
                    type: boolean
                    description: Whether reports should be generated on Sunday.
                  mon:
                    type: boolean
                    description: Whether reports should be generated on Monday.
                  tue:
                    type: boolean
                    description: Whether reports should be generated on Tuesday.
                  wed:
                    type: boolean
                    description: Whether reports should be generated on Wednesday.
                  thu:
                    type: boolean
                    description: Whether reports should be generated on Thursday.
                  fri:
                    type: boolean
                    description: Whether reports should be generated on Friday.
                  sat:
                    type: boolean
                    description: Whether reports should be generated on Saturday.
                description: Set the days of the week on which the reports should be generated, at the hour specified in "activation_hour".
              activation_hour:
                type: integer
                description: Hour of the day to generate and send the quota report. An integer between 0 and 23, with 0 = '12 AM', 1 = '1 AM', ... 23 = '11 PM'.
              admin_report:
                type: boolean
                description: Set whether to generate the administrative report. This reports on all Directory Quota Violations, and is sent to the addresses set to receive email in Email Settings and Configurations.
              user_report:
                type: boolean
                description: Set whether to generate the user report. This reports on individual Directory Quota Violations and will be sent to the address specifed in the Quota or the owner of the directory, if available (CIFS/AD mode only).
              threshold:
                type: integer
                description: Report on Quotas where the usage is at or above the specified percent of the limit.
    FilerConfigurationFTP_2:
      type: object
      properties:
        masq_address:
          type: string
          description: Set the Masquerade address. This IP address is presented to the client instead of the local server's IP.
          readOnly: true
        idle_timeout:
          type: integer
          description: Set the amount of time (in seconds) that a user can stay connected while idle before being disconnected.
          readOnly: true
        anon_user:
          type: string
          description: 'Set the username a user must log in with in order to access FTP directories anonymously. This field is case sensitive. (default: anonymous)'
          readOnly: true
        anon_group:
          type: string
          description: 'Set the Group assigned to the Anonymous User for file permissions. Note: This does not give all members of this group anonymous access. (default: anonymous)'
          readOnly: true
        protocols:
          type: array
          description: List of FTP protocols supported by the Filer.
          readOnly: true
          items:
            type: string
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error_2'
    AMQPAuditDestination:
      required:
      - ca_cert
      - filer_serial_number
      - headers
      - hostname
      - name
      - password
      - port
      - username
      - vhost
      type: object
      properties:
        name:
          type: string
          description: Unique name of this AMQP destination
        filer_serial_number:
          type: string
          description: Identifier of the associated Filer.
        hostname:
          type: string
          description: Hostname or IP of AMQP server
        port:
          type: integer
          description: The AMQP SSL port number to connect to
        ca_cert:
          type: string
          description: The CA certificate that the server certificate was signed with. In the case of a self-signed certificate, this is the certificate itself
        username:
          type: string
          description: Username to authenticate with
        password:
          type: string
          description: Password to authenticate with
        vhost:
          type: string
          description: vHost on the AMQP server to connect to
        exchange:
          type: string
          description: Exchange to post messages to
        routing_key:
          type: string
          description: The routing_key to put in all messages
        headers:
          type: object
          additionalProperties: true
          description: Key value pairs that will be added to AMQP messages as headers
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            filer:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions
          readOnly: true
      description: AMQP Destination for auditing logs object
    Message:
      type: object
      properties:
        id:
          type: string
          description: ID of the message.
        filer_serial_number:
          type: string
          description: Identifier to the Filer the message is associated with.
        description:
          type: string
          description: Description of the intent of message.
        code:
          type: string
          description: A code identifying the intent of the message.
        status:
          type: string
          description: 'Current status of the message.

            * ''synced'' - Message has been received by the Filer, and the Filer returned a success response. * ''pending'' - Message is currently in transit. * ''failure'' - Messages has been received by the Filer, but returned an error response.'
          enum:
          - synced
          - pending
          - failure
        send_time:
          type: string
          description: Time the message was sent.
        expiration_time:
          type: string
          description: Time a synced message will expire and be removed from the messages list.
        response_time:
          type: string
          description: Time a message response was received.
        initiated_by:
          type: string
          description: The username of the user who triggered the message, or '[console]' if triggered by the NMC itself.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            filer:
              $ref: '#/components/schemas/Link_2'
            acknowledge:
              $ref: '#/components/schemas/Link_2'
            applied_resource:
              type: object
              properties:
                href:
                  type: string
                  description: Hyperlink to the resource.
                method:
                  type: string
                  description: HTTP method to use on the link.
              description: Provides a link to the resource being acted on or that was created. When creating a resource, this link will only be available after the message is successfully synced ('status' is 'synced').
          description: Links to related resources, collections, and actions.
        error:
          $ref: '#/components/schemas/Error_2'
      description: The message object is used to track an action that we want the Filer to perform.
    FilerCIFSLock:
      type: object
      properties:
        filer_serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        cifsclient_id:
          type: string
          description: ID of the CIFS client that holds this lock.
          readOnly: true
        share_id:
          type: integer
          description: ID of the CIFS share that the client is connected to.
          readOnly: true
        path:
          type: string
          description: The path to the locked file or directory.
          readOnly: true
        type:
          type: string
          description: The type of lock.
          readOnly: true
        user:
          type: string
          description: The username of the connected client.
          readOnly: true
        client:
          type: string
          description: The IP Address of the client machine.
          readOnly: true
        client_name:
          type: string
          description: The hostname of the connected client.
          readOnly: true
        links:
          type: object
          properties:
            filer:
              $ref: '#/components/schemas/Link_2'
            cifsclient:
              $ref: '#/components/schemas/Link_2'
            share:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: A description of a CIFS file lock held by a connected CIFS client.
    FilerConfigurationCIFS_2:
      type: object
      properties:
        aio_support:
          type: boolean
          description: Read only. Indicates whether Async IO is supported.
          readOnly: true
        deny_access:
          type: boolean
          description: Read only. Indicates whether denying a user access to a share is supported
          readOnly: true
        fruit_support:
          type: boolean
          description: Read only. Indicates whether Mac OS X Extensions are available.
          readOnly: true
        proto_level:
          type: string
          description: 'Read only. Indicates the CIFS protocol level of the Filer.


            * *SMB3* -- CIFS & SMB3 support.

            * *SMB2* -- CIFS & SMB2 support.

            * '''' -- CIFS support.

            '
          readOnly: true
          enum:
          - SMB3
          - SMB2
          - ''
        restrict_anonymous:
          type: boolean
          description: Set whether to restrict anonymous user access.
          readOnly: true
        roundup_size:
          type: string
          description: 'Set the Allocation roundup size.

            This rounds the file size on disk reported to clients. Disabled by

            default, this should only be enabled when the system is being

            accessed by older SMBv1 clients; otherwise, there may be a

            performance impact.

            May also affect file size reporting on some platforms.


            * `` - Allocation roundup size is 1 MiB (default value for Filers older than version 9.0).

            * `0` - Allocation roundup is disabled (default value for Filers version 9.0 and newer).

            * `1048576` - Allocation roundup size is 1 MiB.

            '
          readOnly: true
        smb3:
          type: boolean
          description: Indicates whether SMB3 is supported.
          readOnly: true
        smb_encrypt:
          type: boolean
          description: Indicates whether SMB Encryption is supported.
          readOnly: true
        unix_ext:
          type: boolean
          description: Set whether Enhanced Support for POSIX clients is enabled.
          readOnly: true
        veto_files:
          type: boolean
          description: Indicates whether blocking files is supported. This can be configured through Shares settings.
          readOnly: true
    MessageResponse:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/Message'
    FilerServicesSupport_2:
      type: object
      properties:
        connected:
          type: boolean
          description: Indicates if Nasuni Support is currently connected for Remote Support.
          readOnly: true
        enabled:
          type: boolean
          description: Enable or disable Remote Support.
        running:
          type: boolean
          description: ''
          readOnly: true
        timeout:
          type: integer
          description: Set the timeout in seconds after which Remote Support is automatically disabled.
      description: Enable or disable Remote Support, set the timeout before it is automatically disabled, and report if there is an active connection from Nasuni Support.
    FilerCIFSClient:
      type: object
      properties:
        id:
          type: string
          description: CIFS client ID.
          readOnly: true
        filer_serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        share_id:
          type: integer
          description: ID of the CIFS share that the client is connected to.
          readOnly: true
        user:
          type: string
          description: The username of the connected client.
          readOnly: true
        client:
          type: string
          description: The IP Address of the client machine.
          readOnly: true
        client_name:
          type: string
          description: The hostname of the connected client.
          readOnly: true
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            filer:
              $ref: '#/components/schemas/Link_2'
            share:
              $ref: '#/components/schemas/Link_2'
            locks:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: A description of a connected CIFS client.
    FilerPlatform_2:
      type: object
      properties:
        platform_name:
          type: string
          description: A description of the hardware platform this Filer runs on.
          readOnly: true
        cpu:
          type: object
          properties:
            model:
              type: string
              description: Human-readable description of the CPU model.
              readOnly: true
            frequency:
              type: number
              description: CPU Frequency in MHz.
              readOnly: true
            sockets:
              type: integer
              description: Number of CPU sockets currently used on this Filer's platform.
              readOnly: true
            cores:
              type: integer
              description: Total number of CPU cores across all CPUs.
              readOnly: true
        memory:
          type: string
          description: A string representing an integer. The size in megabytes of the Filer's memory.
          readOnly: true
        cache_status:
          type: object
          properties:
            size:
              type: integer
              description: The size in bytes of the Filer's cache.
              readOnly: true
            used:
              type: integer
              description: The amount in bytes of the Filer's cache currently in use.
              readOnly: true
            dirty:
              type: integer
              description: The amount of data in bytes belonging to files currently marked as needing to be written to storage or re-read into the cache.
              readOnly: true
            free:
              type: integer
              description: The amount in bytes of the Filer's cache currently available.
              readOnly: true
            percent_used:
              type: number
              description: The percentage of the cache currently in use, i.e. used/size.
              readOnly: true
      description: Information about a Filer's platform, including hardware type and information about CPU, Memory, and cache.
    Link_2:
      type: object
      properties:
        href:
          type: string
          description: Hyperlink to the resource.
          readOnly: true
        method:
          type: string
          description: HTTP method to use on the link.
          readOnly: true
    Filer_2:
      type: object
      properties:
        build:
          type: string
          description: Current version and build number of the Filer's software.
          readOnly: true
        description:
          type: string
          description: The Filer's description.
        guid:
          type: string
          description: Unique identifier of the Filer instance.
          readOnly: true
        management_state:
          type: string
          description: 'Current NMC Management state of the Filer. Possible values:


            * ''self'' - Filer is NOT managed by NMC.

            * ''nmc'' -  Filer is managed by NMC.

            * ''pending_self'' - Filer is pending self management.

            * ''pending_nmc'' - Filer is pending NMC management.

            '
          readOnly: true
          enum:
          - self
          - nmc
          - pending_self
          - pending_nmc
        serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        settings:
          type: object
          properties:
            alert_thresholds:
              type: object
              properties:
                cpu_alert_settings:
                  type: object
                  properties:
                    cpu_enabled:
                      type: boolean
                      description: If true, will enable alerts for CPU usage.
                    cpu_threshold:
                      type: integer
                      description: Percentage of CPU usage that can trigger an alert.
                    cpu_duration:
                      type: integer
                      description: Time in minutes that the system will allow CPU usage over the cpu_threshold before trigging an alert.
                  description: Configuration values for alerting on Filer CPU usage.
                memory_alert_settings:
                  type: object
                  properties:
                    memory_enabled:
                      type: boolean
                      description: If true, will enable alerts for memory usage.
                    memory_threshold:
                      type: integer
                      description: Percentage of memory usage that can trigger and alert.
                    memory_duration:
                      type: integer
                      description: Time in minutes that the system will allow memory usage over the memory_threshold before trigging an alert.
                  description: Configuration values for alerting on Filer memory usage.
                snapshot_alert_settings:
                  type: object
                  properties:
                    snapshot_enabled:
                      type: boolean
                      description: If true, will enable alerts for snapshots.
                    snapshot_duration:
                      type: integer
                      description: Time in hours to trigger an alert if a snapshot has not completed.
                  description: Configuration values for alerting on Snapshots.
              description: Filer system alert configuration.
              readOnly: true
            autoupdate:
              $ref: '#/components/schemas/FilerConfigurationAutoupdate_2'
            cache_reserved:
              type: object
              properties:
                reserved:
                  type: string
                  description: Set the percentage of the cache reserved for new, incoming data. A string representing a multiple-of-five integer between 5-90, or the string "unset" if the Filer automatically manages this.
                  enum:
                  - unset
                  - '5'
                  - '10'
                  - '15'
                  - '20'
                  - '25'
                  - '30'
                  - '35'
                  - '40'
                  - '45'
                  - '50'
                  - '55'
                  - '60'
                  - '65'
                  - '70'
                  - '75'
                  - '80'
                  - '85'
                  - '90'
                maxv:
                  type: integer
                  description: Read only. Maximum percentage of the cache reserved for new, incoming data.
                minv:
                  type: integer
                  description: Read only. Minimum percentage of the cache reserved for new, incoming data.
              readOnly: true
            cifs:
              $ref: '#/components/schemas/FilerConfigurationCIFS_2'
            escrow_passphrase:
              type: string
              description: An obfuscated string ('*****'), indicating an escrow_passphrase is set. 'null' if a passphrase is not set. Beginning with the 9.3 release, you must set an escrow passphrase before generating new encryption keys or escrowing uploaded encryption keys with Nasuni.
            ftp:
              $ref: '#/components/schemas/FilerConfigurationFTP_2'
            gl_settings:
              type: object
              properties:
                degrade_to_read_locks:
                  type: boolean
                  description: Set whether or not to degrade all locks to read locks. Enabling this feature will cause all locks that are not read locks to be denied. This feature should only be enabled if the lock server is not available for an extended period of time. This feature effectively makes any directories with global locks enabled read only.
              description: Settings that control certain aspects of Global Locking.
              readOnly: true
            mobile_service:
              $ref: '#/components/schemas/FilerServicesMobile'
            qos:
              type: object
              properties:
                rules:
                  type: array
                  description: QoS rules
                  items:
                    type: object
                    properties:
                      days:
                        type: object
                        properties:
                          mon:
                            type: boolean
                          tue:
                            type: boolean
                          wed:
                            type: boolean
                          thu:
                            type: boolean
                          fri:
                            type: boolean
                          sat:
                            type: boolean
                          sun:
                            type: boolean
                        description: Days of the week to apply the QoS rule.
                      start:
                        type: integer
                        description: Hour of the day (0-23) to start applying the QoS rule.
                      stop:
                        type: integer
                        description: Hour of the day (0-23) to stop applying the QoS rule.
                      limit:
                        type: integer
                        description: The maximum outbound data rate in bytes. Specify zero for no limit.
                      ingress_limit:
                        type: integer
                        description: The maximum inbound data rate in bytes. Specify zero for no limit.
              description: Quality of Service configuration.
              readOnly: true
            quota_report_schedule:
              $ref: '#/components/schemas/FilerConfigurationQuotaReportSchedule_2'
            remote_support:
              $ref: '#/components/schemas/FilerServicesSupport_2'
            snmp:
              type: object
              properties:
                v2_enabled:
                  type: boolean
                  description: If true, will enable v1,v2c support.
                v2_community:
                  type: string
                  description: 'SNMP Community name (ex: ''public'').

                    '
                v3_enabled:
                  type: boolean
                  description: If true, will enable v3 support.
                v3_username:
                  type: string
                  description: Username for SNMP v3 authentication.
                v3_password:
                  type: string
                  description: Password for SNMP v3 authentication. SHA authentication and optional privileged security using AES encryption are used to communicate to the SNMP agent. Will display a masked value of '*****' if a password exists, otherwise will be blank.
                sys_location:
                  type: string
                  description: 'SNMP System Location (ex: ''Boston Colo - Rack 1'').

                    '
                sys_contact:
                  type: string
                  description: 'SNMP system contact (ex: ''Support <support@example.com>'').

                    '
                trap_ips:
                  type: array
                  description: List of IPs or hostnames listening for SNMP traps. Leave blank if you wish not to listen for SNMP traps. Traps will be sent using SNMP v3 settings above and the Filer's unique engine id.
                  items:
                    type: string
                    description: IPs or hostnames listening for SNMP traps.
              description: Filer SNMP Settings
              readOnly: true
            time:
              type: object
              properties:
                ntpservers:
                  type: array
                  items:
                    type: string
                    description: A host running the Network Time Protocol (NTP).
                timezone:
                  type: string
                  description: Timezone of the Filer.
                current_time_utc:
                  type: string
                  description: Current time reported by the Filer. Last report time will only be updated periodically unless manually refreshed.
              description: Filer Time Configuration
              readOnly: true
          description: Settings that are associated with this Filer.
        status:
          type: object
          properties:
            offline:
              type: boolean
              description: If true, the Filer has not reported back to the NMC within the last hour.
            osversion:
              type: string
              description: The version of the Operating System running on this filer.
            platform:
              $ref: '#/components/schemas/FilerPlatform_2'
            updates:
              type: object
              properties:
                updates_available:
                  type: boolean
                  description: Indicates whether or not there are software updates available for the Filer.
                current_version:
                  type: string
                  description: The current version of the software running on this Filer.
                new_version:
                  type: string
                  description: If an update is available, this indicates the new version of the software which will be installed.
              description: Information about the current software version and the availability of updates.
            uptime:
              type: integer
              description: Uptime of this Filer, in seconds.
          description: Filer status.
          readOnly: true
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            cifsclients:
              $ref: '#/components/schemas/Link_2'
            cifslocks:
              $ref: '#/components/schemas/Link_2'
            ftpclients:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: Complete Filer object with all associated settings and statuses.
    EncryptionKey:
      type: object
      properties:
        id:
          type: integer
          description: Encryption key identifier
          readOnly: true
        filer_serial_number:
          type: string
          description: Unique identifier for the associated filer.
          readOnly: true
        fingerprint:
          type: string
          description: Encryption key fingerprint
          readOnly: true
        key_id:
          type: string
          description: Shorthand key identifier (last 8 characters of the fingerprint)
          readOnly: true
        name:
          type: string
          description: The name of the encryption key.
          readOnly: true
        algorithm:
          type: string
          description: The encryption algorithm used.
          readOnly: true
        length:
          type: integer
          description: The length of the encryption key in bits.
          readOnly: true
        escrowed:
          type: boolean
          description: If true, the key has been escrowed with Nasuni.
          readOnly: true
        used:
          type: boolean
          description: If true, the key is currently in use by a volume or for filer configuration backup.
          readOnly: true
        is_backup_key:
          type: boolean
          description: If true, the encryption is a backup key. Backup keys are generally only used for filers that do not have any local volumes, to preform configuration backup.
          readOnly: true
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            filer:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: OpenPGP key
    Error_2:
      type: object
      properties:
        code:
          type: string
          description: 'Specifies the type of error reported. Possible values:


            * "error" - General error

            * "validation_error" - Validation error

            * "not_found_error" - Resource not found

            * "auth_error" - Authentication error

            * "perm_error" - Permission error

            * "sync_error" - Error occurred syncing settings with a Filer.

            * "unmanaged_error" - Resource is not managed.

            * "conflict_error" - Conflict error

            * "unsupported_error" - Current filer version does not support this type of request.

            * "throttled_error" - The request was throttled; too many sent within a duration.

            '
          readOnly: true
          enum:
          - error
          - validation_error
          - not_found_error
          - auth_error
          - perm_error
          - sync_error
          - unmanaged_error
          - conflict_error
          - unsupported_error
          - throttled_error
        description:
          type: string
          description: Description of the error reported.
          readOnly: true
    FilerHealthStatus:
      type: object
      properties:
        filer_serial_number:
          type: string
          description: Unique identifier for the associated filer.
          readOnly: true
        last_updated:
          type: string
          description: The last time system health values were updated.
          readOnly: true
        smb:
          $ref: '#/components/schemas/HealthItem'
        network:
          $ref: '#/components/schemas/HealthItem'
        filesystem:
          $ref: '#/components/schemas/HealthItem'
        unityfs:
          $ref: '#/components/schemas/HealthItem'
        nfs:
          $ref: '#/components/schemas/HealthItem'
        memory:
          $ref: '#/components/schemas/HealthItem'
        services:
          $ref: '#/components/schemas/HealthItem'
        directoryservices:
          $ref: '#/components/schemas/HealthItem'
        disk:
          $ref: '#/components/schemas/HealthItem'
        cpu:
          $ref: '#/components/schemas/HealthItem'
        fileaccelerator:
          $ref: '#/components/schemas/HealthItem'
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            filer:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions.
      description: Status of a given filer. Fields listed as "Warn" have one or more checks failing moderately. Fields listed as "Fail" have one or more checks failing severely.
    FilerFTPClient:
      type: object
      properties:
        id:
          type: string
          description: FTP client ID.
          readOnly: true
        filer_serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        protocol:
          type: string
          description: The connection's protocol.
          readOnly: true
          enum:
          - ftp
          - sftp
        client:
          type: string
          description: The IP Address of the client machine.
          readOnly: true
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_2'
            filer:
              $ref: '#/components/schemas/Link_2'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: A description of a connected (S)FTP client.
    FilerConfigurationAutoupdate_3:
      type: object
      properties:
        hour:
          type: integer
          description: Hour of the day to perform automatic updates. An integer between 0 and 23, with 0 = '12 AM', 1 = '1 AM', ... 23 = '11 PM'.
          readOnly: true
        sun:
          type: boolean
          description: Whether the Filer runs automatic updates on Sunday.
          readOnly: true
        mon:
          type: boolean
          description: Whether the Filer runs automatic updates on Monday.
          readOnly: true
        tue:
          type: boolean
          description: Whether the Filer runs automatic updates on Tuesday.
          readOnly: true
        wed:
          type: boolean
          description: Whether the Filer runs automatic updates on Wednesday.
          readOnly: true
        thu:
          type: boolean
          description: Whether the Filer runs automatic updates on Thursday.
          readOnly: true
        fri:
          type: boolean
          description: Whether the Filer runs automatic updates on Friday.
          readOnly: true
        sat:
          type: boolean
          description: Whether the Filer runs automatic updates on Saturday.
          readOnly: true
    Paging_2:
      type: object
      properties:
        href:
          type: string
          description: A link to the requested endpoint.
        limit:
          type: integer
          description: The maximum number of items in a page.
        next:
          type:
          - string
          - 'null'
          description: A link to the next page of objects. The value will be null if there isn't one.
        offset:
          type: integer
          description: The item number the page starts on.
        previous:
          type:
          - string
          - 'null'
          description: A link to the previous page of objects. The value will be null if there isn't one.
        total:
          type: integer
          description: Total number of items available at the requested endpoint.
      description: The paging object provides a container for a listing of objects, defining the start, end, and total size of the listing. Any endpoint that returns a list of items, will likely be wrapped in a paging object.
    FilerConfigurationQuotaReportSchedule_3:
      type: object
      properties:
        schedules:
          type: array
          items:
            type: object
            properties:
              days:
                type: object
                properties:
                  sun:
                    type: boolean
                    description: Whether reports should be generated on Sunday.
                  mon:
                    type: boolean
                    description: Whether reports should be generated on Monday.
                  tue:
                    type: boolean
                    description: Whether reports should be generated on Tuesday.
                  wed:
                    type: boolean
                    description: Whether reports should be generated on Wednesday.
                  thu:
                    type: boolean
                    description: Whether reports should be generated on Thursday.
                  fri:
                    type: boolean
                    description: Whether reports should be generated on Friday.
                  sat:
                    type: boolean
                    description: Whether reports should be generated on Saturday.
                description: Set the days of the week on which the reports should be generated, at the hour specified in "activation_hour".
              activation_hour:
                type: integer
                description: Hour of the day to generate and send the quota report. An integer between 0 and 23, with 0 = '12 AM', 1 = '1 AM', ... 23 = '11 PM'.
              admin_report:
                type: boolean
                description: Set whether to generate the administrative report. This reports on all Directory Quota Violations, and is sent to the addresses set to receive email in Email Settings and Configurations.
              user_report:
                type: boolean
                description: Set whether to generate the user report. This reports on individual Directory Quota Violations and will be sent to the address specified in the Quota or the owner of the directory, if available (CIFS/AD mode only).
              threshold:
                type: integer
                description: Report on Quotas where the usage is at or above the specified percent of the limit.
    FilerConfigurationFTP_3:
      type: object
      properties:
        masq_address:
          type: string
          description: Set the Masquerade address. This IP address is presented to the client instead of the local server's IP.
          readOnly: true
        idle_timeout:
          type: integer
          description: Set the amount of time (in seconds) that a user can stay connected while idle before being disconnected.
          readOnly: true
        anon_user:
          type: string
          description: 'Set the username a user must log in with in order to access FTP directories anonymously. This field is case sensitive. (default: anonymous)'
          readOnly: true
        anon_group:
          type: string
          description: 'Set the Group assigned to the Anonymous User for file permissions. Note: This does not give all members of this group anonymous access. (default: anonymous)'
          readOnly: true
        protocols:
          type: array
          description: List of FTP protocols supported by the Filer.
          readOnly: true
          items:
            type: string
    ErrorResponse_2:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error_3'
    AMQPAuditDestination_2:
      required:
      - ca_cert
      - filer_serial_number
      - headers
      - hostname
      - name
      - password
      - port
      - username
      - vhost
      type: object
      properties:
        name:
          type: string
          description: Unique name of this AMQP destination
        filer_serial_number:
          type: string
          description: Identifier of the associated Filer.
        hostname:
          type: string
          description: Hostname or IP of AMQP server
        port:
          type: integer
          description: The AMQP SSL port number to connect to
        ca_cert:
          type: string
          description: The CA certificate that the server certificate was signed with. In the case of a self-signed certificate, this is the certificate itself
        username:
          type: string
          description: Username to authenticate with
        password:
          type: string
          description: Password to authenticate with
        vhost:
          type: string
          description: vHost on the AMQP server to connect to
        exchange:
          type: string
          description: Exchange to post messages to
        routing_key:
          type: string
          description: The routing_key to put in all messages
        headers:
          type: object
          properties: {}
          description: Key value pairs that will be added to AMQP messages as headers
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            filer:
              $ref: '#/components/schemas/Link_3'
          description: Links to related resources, collections, and actions
          readOnly: true
      description: AMQP Destination for auditing logs object
    BlockedSourceIpAddress:
      required:
      - blocked_by_username
      - filer_serial_number
      - blocked_date
      - ip_address
      type: object
      properties:
        blocked_by_username:
          type:
          - string
          - 'null'
          description: Username of admin who manually blocked this source IP address. Null if blocked automatically by ransomware mitigation.
          readOnly: true
        filer_serial_number:
          type: string
          description: Unique identifier for the associated filer.
          readOnly: true
        blocked_date:
          type: string
          description: Date and time at which source IP address was blocked.
          readOnly: true
        ip_address:
          type: string
          description: IP address of the blocked source IP address.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            filer:
              $ref: '#/components/schemas/Link_3'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: A blocked source IP address object
    Message_2:
      type: object
      properties:
        id:
          type: string
          description: ID of the message.
        filer_serial_number:
          type: string
          description: Identifier to the Filer the message is associated with.
        description:
          type: string
          description: Description of the intent of message.
        code:
          type: string
          description: A code identifying the intent of the message.
        status:
          type: string
          description: 'Current status of the message.

            * ''synced'' - Message has been received by the Filer, and the Filer returned a success response. * ''pending'' - Message is currently in transit. * ''failure'' - Messages has been received by the Filer, but returned an error response.'
          enum:
          - synced
          - pending
          - failure
        send_time:
          type: string
          description: Time the message was sent.
        expiration_time:
          type:
          - string
          - 'null'
          description: Time a synced message will expire and be removed from the messages list.
        response_time:
          type:
          - string
          - 'null'
          description: Time a message response was received.
        initiated_by:
          type: string
          description: The username of the user who triggered the message, or '[console]' if triggered by the NMC itself.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            filer:
              $ref: '#/components/schemas/Link_3'
            acknowledge:
              $ref: '#/components/schemas/Link_3'
            applied_resource:
              type: object
              properties:
                href:
                  type: string
                  description: Hyperlink to the resource.
                method:
                  type: string
                  description: HTTP method to use on the link.
              description: Provides a link to the resource being acted on or that was created. When creating a resource, this link will only be available after the message is successfully synced ('status' is 'synced').
          description: Links to related resources, collections, and actions.
        error:
          $ref: '#/components/schemas/Error_3'
      description: The message object is used to track an action that we want the Filer to perform.
    FilerCIFSLock_2:
      type: object
      properties:
        filer_serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        cifsclient_id:
          type: string
          description: ID of the CIFS client that holds this lock.
          readOnly: true
        share_id:
          type: integer
          description: ID of the CIFS share that the client is connected to.
          readOnly: true
        path:
          type: string
          description: The path to the locked file or directory.
          readOnly: true
        type:
          type: string
          description: The type of lock.
          readOnly: true
        user:
          type: string
          description: The username of the connected client.
          readOnly: true
        client:
          type: string
          description: The IP Address of the client machine.
          readOnly: true
        client_name:
          type: string
          description: The hostname of the connected client.
          readOnly: true
      description: A description of a CIFS file lock held by a connected CIFS client.
    FilerConfigurationCIFS_3:
      type: object
      properties:
        aio_support:
          type: boolean
          description: Read only. Indicates whether Async IO is supported.
          readOnly: true
        deny_access:
          type: boolean
          description: Read only. Indicates whether denying a user access to a share is supported
          readOnly: true
        fruit_support:
          type: boolean
          description: Read only. Indicates whether Mac OS X Extensions are available.
          readOnly: true
        proto_level:
          type: string
          description: 'Read only. Indicates the CIFS protocol level of the Filer.


            * *SMB3* -- CIFS & SMB3 support.

            * *SMB2* -- CIFS & SMB2 support.

            * '''' -- CIFS support.

            '
          readOnly: true
          enum:
          - SMB3
          - SMB2
          - ''
        restrict_anonymous:
          type: boolean
          description: Set whether to restrict anonymous user access.
          readOnly: true
        roundup_size:
          type: string
          description: 'Set the Allocation roundup size.

            This rounds the file size on disk reported to clients. Disabled by

            default, this should only be enabled when the system is being

            accessed by older SMBv1 clients; otherwise, there may be a

            performance impact.

            May also affect file size reporting on some platforms.


            * `` - Allocation roundup size is 1 MiB (default value for Filers older than version 9.0).

            * `0` - Allocation roundup is disabled (default value for Filers version 9.0 and newer).

            * `1048576` - Allocation roundup size is 1 MiB.

            '
          readOnly: true
        smb3:
          type: boolean
          description: Indicates whether SMB3 is supported.
          readOnly: true
        smb_encrypt:
          type: boolean
          description: Indicates whether SMB Encryption is supported.
          readOnly: true
        unix_ext:
          type: boolean
          description: Set whether Enhanced Support for POSIX clients is enabled.
          readOnly: true
        veto_files:
          type: boolean
          description: Indicates whether blocking files is supported. This can be configured through Shares settings.
          readOnly: true
    BlockedSourceUsername:
      required:
      - blocked_by_username
      - filer_serial_number
      - blocked_date
      - username
      type: object
      properties:
        blocked_by_username:
          type:
          - string
          - 'null'
          description: Username of admin who manually blocked this source username. Null if blocked automatically by ransomware mitigation.
          readOnly: true
        filer_serial_number:
          type: string
          description: Unique identifier for the associated filer.
          readOnly: true
        blocked_date:
          type: string
          description: Date and time at which source username was blocked.
          readOnly: true
        username:
          type: string
          description: username of the blocked source username.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            filer:
              $ref: '#/components/schemas/Link_3'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: A blocked source username object
    FilerServicesSupport_3:
      type: object
      properties:
        connected:
          type: boolean
          description: Indicates if Nasuni Support is currently connected for Remote Support.
          readOnly: true
        enabled:
          type: boolean
          description: Enable or disable Remote Support.
        running:
          type: boolean
          description: ''
          readOnly: true
        timeout:
          type: integer
          description: Set the timeout in seconds after which Remote Support is automatically disabled.
      description: Enable or disable Remote Support, set the timeout before it is automatically disabled, and report if there is an active connection from Nasuni Support.
    FilerCIFSClient_2:
      type: object
      properties:
        id:
          type: string
          description: CIFS client ID.
          readOnly: true
        filer_serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        share_id:
          type: integer
          description: ID of the CIFS share that the client is connected to.
          readOnly: true
        user:
          type: string
          description: The username of the connected client.
          readOnly: true
        client:
          type: string
          description: The IP Address of the client machine.
          readOnly: true
        client_name:
          type: string
          description: The hostname of the connected client.
          readOnly: true
      description: A description of a connected CIFS client.
    FilerPlatform_3:
      type: object
      properties:
        platform_name:
          type: string
          description: A description of the hardware platform this Filer runs on.
          readOnly: true
        cpu:
          type: object
          properties:
            model:
              type: string
              description: Human-readable description of the CPU model.
              readOnly: true
            frequency:
              type: number
              description: CPU Frequency in MHz.
              readOnly: true
            sockets:
              type: integer
              description: Number of CPU sockets currently used on this Filer's platform.
              readOnly: true
            cores:
              type: integer
              description: Total number of CPU cores across all CPUs.
              readOnly: true
        memory:
          type: string
          description: A string representing an integer. The size in megabytes of the Filer's memory.
          readOnly: true
        cache_status:
          type: object
          properties:
            size:
              type: integer
              description: The size in bytes of the Filer's cache.
              readOnly: true
            used:
              type: integer
              description: The amount in bytes of the Filer's cache currently in use.
              readOnly: true
            dirty:
              type: integer
              description: The amount of data in bytes belonging to files currently marked as needing to be written to storage or re-read into the cache.
              readOnly: true
            free:
              type: integer
              description: The amount in bytes of the Filer's cache currently available.
              readOnly: true
            percent_used:
              type: number
              description: The percentage of the cache currently in use, i.e. used/size.
              readOnly: true
      description: Information about a Filer's platform, including hardware type and information about CPU, Memory, and cache.
    BlockedClient:
      required:
      - blocked_by_username
      - filer_serial_number
      - blocked_date
      - ip_address
      type: object
      properties:
        blocked_by_username:
          type:
          - string
          - 'null'
          description: Username of admin who manually blocked this client. Null if blocked automatically by ransomware mitigation.
          readOnly: true
        filer_serial_number:
          type: string
          description: Unique identifier for the associated filer.
          readOnly: true
        blocked_date:
          type: string
          description: Date and time at which client was blocked.
          readOnly: true
        ip_address:
          type: string
          description: IP address of the blocked client.
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            filer:
              $ref: '#/components/schemas/Link_3'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: A blocked client object
    Link_3:
      type: object
      properties:
        href:
          type: string
          description: Hyperlink to the resource.
          readOnly: true
        method:
          type: string
          description: HTTP method to use on the link.
          readOnly: true
    Filer_3:
      type: object
      properties:
        build:
          type: string
          description: Current version and build number of the Filer's software.
          readOnly: true
        description:
          type: string
          description: The Filer's description.
        guid:
          type: string
          description: Unique identifier of the Filer instance.
          readOnly: true
        management_state:
          type: string
          description: 'Current NMC Management state of the Filer. Possible values:


            * ''self'' - Filer is NOT managed by NMC.

            * ''nmc'' -  Filer is managed by NMC.

            * ''pending_self'' - Filer is pending self management.

            * ''pending_nmc'' - Filer is pending NMC management.

            '
          readOnly: true
          enum:
          - self
          - nmc
          - pending_self
          - pending_nmc
        serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        settings:
          type: object
          properties:
            alert_thresholds:
              type: object
              properties:
                cpu_alert_settings:
                  type: object
                  properties:
                    cpu_enabled:
                      type: boolean
                      description: If true, will enable alerts for CPU usage.
                    cpu_threshold:
                      type: integer
                      description: Percentage of CPU usage that can trigger an alert.
                    cpu_duration:
                      type: integer
                      description: Time in minutes that the system will allow CPU usage over the cpu_threshold before trigging an alert.
                  description: Configuration values for alerting on Filer CPU usage.
                memory_alert_settings:
                  type: object
                  properties:
                    memory_enabled:
                      type: boolean
                      description: If true, will enable alerts for memory usage.
                    memory_threshold:
                      type: integer
                      description: Percentage of memory usage that can trigger and alert.
                    memory_duration:
                      type: integer
                      description: Time in minutes that the system will allow memory usage over the memory_threshold before trigging an alert.
                  description: Configuration values for alerting on Filer memory usage.
                snapshot_alert_settings:
                  type: object
                  properties:
                    snapshot_enabled:
                      type: boolean
                      description: If true, will enable alerts for snapshots.
                    snapshot_duration:
                      type: integer
                      description: Time in hours to trigger an alert if a snapshot has not completed.
                  description: Configuration values for alerting on Snapshots.
              description: Filer system alert configuration.
              readOnly: true
            autoupdate:
              $ref: '#/components/schemas/FilerConfigurationAutoupdate_3'
            cache_reserved:
              type: object
              properties:
                reserved:
                  type: string
                  description: Set the percentage of the cache reserved for new, incoming data. A string representing a multiple-of-five integer between 5-90, or the string "unset" if the Filer automatically manages this.
                  enum:
                  - unset
                  - '5'
                  - '10'
                  - '15'
                  - '20'
                  - '25'
                  - '30'
                  - '35'
                  - '40'
                  - '45'
                  - '50'
                  - '55'
                  - '60'
                  - '65'
                  - '70'
                  - '75'
                  - '80'
                  - '85'
                  - '90'
                maxv:
                  type: integer
                  description: Read only. Maximum percentage of the cache reserved for new, incoming data.
                minv:
                  type: integer
                  description: Read only. Minimum percentage of the cache reserved for new, incoming data.
              readOnly: true
            cifs:
              $ref: '#/components/schemas/FilerConfigurationCIFS_3'
            escrow_passphrase:
              type:
              - string
              - 'null'
              description: An obfuscated string ('*****'), indicating an escrow_passphrase is set. 'null' if a passphrase is not set. Beginning with the 9.3 release, you must set an escrow passphrase before generating new encryption keys or escrowing uploaded encryption keys with Nasuni.
            ftp:
              $ref: '#/components/schemas/FilerConfigurationFTP_3'
            gl_settings:
              type: object
              properties:
                degrade_to_read_locks:
                  type: boolean
                  description: Set whether or not to degrade all locks to read locks. Enabling this feature will cause all locks that are not read locks to be denied. This feature should only be enabled if the lock server is not available for an extended period of time. This feature effectively makes any directories with global locks enabled read only.
              description: Settings that control certain aspects of Global Locking.
              readOnly: true
            mobile_service:
              $ref: '#/components/schemas/FilerServicesMobile'
            network_settings:
              type:
              - object
              - 'null'
              properties:
                hostname:
                  type: string
                  description: The filer's hostname.
                default_gateway:
                  type: string
                  description: The filer's default gateway.
                ip_addresses:
                  type: array
                  items:
                    type: string
                    description: IP Address that the filer exists on.
                dns_servers:
                  type: array
                  items:
                    type: string
                    description: DNS Server for the filer.
                search_domains:
                  type: array
                  items:
                    type: string
                    description: Search domain for the filer.
              readOnly: true
              description: A filer's relevant network configuration settings.
            qos:
              type: object
              properties:
                rules:
                  type: array
                  description: QoS rules
                  items:
                    type: object
                    properties:
                      days:
                        type: object
                        properties:
                          mon:
                            type: boolean
                          tue:
                            type: boolean
                          wed:
                            type: boolean
                          thu:
                            type: boolean
                          fri:
                            type: boolean
                          sat:
                            type: boolean
                          sun:
                            type: boolean
                        description: Days of the week to apply the QoS rule.
                      start:
                        type: integer
                        description: Hour of the day (0-23) to start applying the QoS rule.
                      stop:
                        type: integer
                        description: Hour of the day (0-23) to stop applying the QoS rule.
                      limit:
                        type: integer
                        description: The maximum outbound data rate in bytes. Specify zero for no limit.
                      ingress_limit:
                        type: integer
                        description: The maximum inbound data rate in bytes. Specify zero for no limit.
              description: Quality of Service configuration.
              readOnly: true
            quota_report_schedule:
              $ref: '#/components/schemas/FilerConfigurationQuotaReportSchedule_3'
            remote_support:
              $ref: '#/components/schemas/FilerServicesSupport_3'
            snmp:
              type: object
              properties:
                v2_enabled:
                  type: boolean
                  description: If true, will enable v1,v2c support.
                v2_community:
                  type: string
                  description: 'SNMP Community name (ex: ''public'').

                    '
                v3_enabled:
                  type: boolean
                  description: If true, will enable v3 support.
                v3_username:
                  type: string
                  description: Username for SNMP v3 authentication.
                v3_password:
                  type: string
                  description: Password for SNMP v3 authentication. SHA authentication and optional privileged security using AES encryption are used to communicate to the SNMP agent. Will display a masked value of '*****' if a password exists, otherwise will be blank.
                sys_location:
                  type: string
                  description: 'SNMP System Location (ex: ''Boston Colo - Rack 1'').

                    '
                sys_contact:
                  type: string
                  description: 'SNMP system contact (ex: ''Support <support@example.com>'').

                    '
                trap_ips:
                  type: array
                  description: List of IPs or hostnames listening for SNMP traps. Leave blank if you wish not to listen for SNMP traps. Traps will be sent using SNMP v3 settings above and the Filer's unique engine id.
                  items:
                    type: string
                    description: IPs or hostnames listening for SNMP traps.
              description: Filer SNMP Settings
              readOnly: true
            time:
              type: object
              properties:
                ntpservers:
                  type: array
                  items:
                    type: string
                    description: A host running the Network Time Protocol (NTP).
                timezone:
                  type: string
                  description: Timezone of the Filer.
                current_time_utc:
                  type: string
                  description: Current time reported by the Filer. Last report time will only be updated periodically unless manually refreshed.
              description: Filer Time Configuration
              readOnly: true
          description: Settings that are associated with this Filer.
        status:
          type: object
          properties:
            offline:
              type: boolean
              description: If true, the Filer has not reported back to the NMC within the last hour.
            osversion:
              type: string
              description: The version of the Operating System running on this filer.
            platform:
              $ref: '#/components/schemas/FilerPlatform_3'
            updates:
              type: object
              properties:
                updates_available:
                  type: boolean
                  description: Indicates whether or not there are software updates available for the Filer.
                current_version:
                  type: string
                  description: The current version of the software running on this Filer.
                new_version:
                  type:
                  - string
                  - 'null'
                  description: If an update is available, this indicates the new version of the software which will be installed.
              description: Information about the current software version and the availability of updates.
            uptime:
              type: integer
              description: Uptime of this Filer, in seconds.
          description: Filer status.
          readOnly: true
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            cifsclients:
              $ref: '#/components/schemas/Link_3'
            cifslocks:
              $ref: '#/components/schemas/Link_3'
            ftpclients:
              $ref: '#/components/schemas/Link_3'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: Complete Filer object with all associated settings and statuses.
    EncryptionKey_2:
      type: object
      properties:
        id:
          type: integer
          description: Encryption key identifier
          readOnly: true
        filer_serial_number:
          type: string
          description: Unique identifier for the associated filer.
          readOnly: true
        fingerprint:
          type: string
          description: Encryption key fingerprint
          readOnly: true
        key_id:
          type: string
          description: Shorthand key identifier (last 8 characters of the fingerprint)
          readOnly: true
        name:
          type: string
          description: The name of the encryption key.
          readOnly: true
        algorithm:
          type: string
          description: The encryption algorithm used.
          readOnly: true
        length:
          type: integer
          description: The length of the encryption key in bits.
          readOnly: true
        escrowed:
          type: boolean
          description: If true, the key has been escrowed with Nasuni.
          readOnly: true
        used:
          type: boolean
          description: If true, the key is currently in use by a volume or for filer configuration backup.
          readOnly: true
        is_backup_key:
          type: boolean
          description: If true, the encryption is a backup key. Backup keys are generally only used for filers that do not have any local volumes, to preform configuration backup.
          readOnly: true
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link_3'
            filer:
              $ref: '#/components/schemas/Link_3'
          description: Links to related resources, collections, and actions.
          readOnly: true
      description: OpenPGP key
    Error_3:
      type: object
      properties:
        code:
          type: string
          description: 'Specifies the type of error reported. Possible values:


            * "error" - General error

            * "validation_error" - Validation error

            * "not_found_error" - Resource not found

            * "auth_error" - Authentication error

            * "perm_error" - Permission error

            * "sync_error" - Error occurred syncing settings with a Filer.

            * "unmanaged_error" - Resource is not managed.

            * "conflict_error" - Conflict error

            * "unsupported_error" - Current filer version does not support this type of request.

            * "throttled_error" - The request was throttled; too many sent within a duration.

            '
          readOnly: true
          enum:
          - error
          - validation_error
          - not_found_error
          - auth_error
          - perm_error
          - sync_error
          - unmanaged_error
          - conflict_error
          - unsupported_error
          - throttled_error
        description:
          type: string
          description: Description of the error reported.
          readOnly: true
    FilerFTPClient_2:
      type: object
      properties:
        id:
          type: string
          description: FTP client ID.
          readOnly: true
        filer_serial_number:
          type: string
          description: Serial number of the Filer.
          readOnly: true
        protocol:
          type: string
          description: The connection's protocol.
          readOnly: true
          enum:
          - ftp
          - sftp
        client:
          type: string
          description: The IP Address of the client machine.
          readOnly: true
      description: A description of a connected (S)FTP client.
  securitySchemes:
    AuthToken:
      type: apiKey
      description: 'This header is required to make authenticated requests. The value format is:


        Token [your_auth_token]

        '
      name: Authorization
      in: header
x-refined-from:
- nasuni-nmc-v1-0-openapi.yml
- nasuni-nmc-v1-1-openapi.yml
- nasuni-nmc-v1-2-openapi.yml