Pure Storage SNMP Managers API

Manages connections to Simple Network Management Protocol (SNMP) managers.

Documentation

Specifications

Code Examples

Schemas & Data

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

Other Resources

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

OpenAPI Specification

pure-storage-snmp-managers-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory SNMP Managers API
  version: '2.52'
  description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos

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

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

    '
servers:
- url: /
tags:
- name: SNMP Managers
  description: 'Manages connections to Simple Network Management Protocol (SNMP) managers.

    '
paths:
  /api/2.52/snmp-managers:
    get:
      tags:
      - SNMP Managers
      summary: Pure Storage List SNMP Managers
      description: Displays designated SNMP managers and their communication and security attributes.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpManagerGetResponse'
    post:
      tags:
      - SNMP Managers
      summary: Pure Storage Create SNMP Manager
      description: 'Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the

        protocol attributes for communicating with it. Once a manager object is created, the

        transmission of SNMP traps is immediately enabled.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpManagerPost'
        required: true
        x-codegen-request-body-name: snmp-manager
      responses:
        '200':
          description: Returns the newly created snmp manager object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpManagerResponse'
      x-codegen-request-body-name: snmp-manager
    delete:
      tags:
      - SNMP Managers
      summary: Pure Storage Delete SNMP Manager
      description: 'Deletes the SNMP manager object and stops communication with specified managers.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - SNMP Managers
      summary: Pure Storage Modify SNMP Manager
      description: Modifies the name or the protocol attributes of the specified SNMP manager.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpManagerPatch'
        required: true
        x-codegen-request-body-name: snmp-manager
      responses:
        '200':
          description: Returns the newly updated snmp manager object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpManagerResponse'
      x-codegen-request-body-name: snmp-manager
  /api/2.52/snmp-managers/test:
    get:
      tags:
      - SNMP Managers
      summary: Pure Storage List SNMP Manager Test Results
      description: Displays SNMP manager test results (traps or informs).
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultWithResourceGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultWithResourceGetResponse'
  /api/2.26/snmp-managers:
    get:
      tags:
      - SNMP Managers
      summary: Pure Storage GET Snmp-managers
      description: List SNMP managers and their attributes.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpManagerGetResponse'
    post:
      tags:
      - SNMP Managers
      summary: Pure Storage POST Snmp-managers
      description: Create an SNMP manager.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpManagerPost_2'
        required: true
        x-codegen-request-body-name: snmp-manager
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpManagerResponse'
      x-codegen-request-body-name: snmp-manager
    delete:
      tags:
      - SNMP Managers
      summary: Pure Storage DELETE Snmp-managers
      description: Remove an SNMP manager.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
    patch:
      tags:
      - SNMP Managers
      summary: Pure Storage PATCH Snmp-managers
      description: Modify SNMP manager attributes such as versions.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnmpManager_2'
        required: true
        x-codegen-request-body-name: snmp-manager
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnmpManagerResponse'
      x-codegen-request-body-name: snmp-manager
  /api/2.26/snmp-managers/test:
    get:
      tags:
      - SNMP Managers
      summary: Pure Storage GET Snmp-managers/test
      description: Test if the configuration of an SNMP manager is valid.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultGetResponse'
components:
  schemas:
    _errorContextResponse:
      type: object
      properties:
        errors:
          description: The list of errors encountered when attempting to perform an operation.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/_errorcontextresponseErrors'
    _snmp_v2c:
      description: 'The v2c configurations of SNMP.

        '
      type: object
      properties:
        community:
          description: 'Manager community ID under which Purity//FA is to communicate with the specified managers.

            '
          type: string
          maxLength: 32
          example: '****'
    SnmpManagerPatch:
      allOf:
      - $ref: '#/components/schemas/_resourceNoId'
      - type: object
        properties:
          host:
            description: 'DNS hostname or IP address of a computer that hosts an SNMP manager

              to which Purity//FA is to send trap messages when it generates alerts.

              '
            type: string
            example: snmp.purestorage.com
          notification:
            description: 'The type of notification the agent will send.

              Valid values are `inform` and `trap`.

              '
            type: string
            example: trap
          v2c:
            $ref: '#/components/schemas/_snmp_v2c'
          v3:
            $ref: '#/components/schemas/_snmp_v3_patch'
          version:
            description: 'Version of the SNMP protocol to be used by Purity//FA to communicate with the specified

              manager. Valid values are `v2c` and `v3`.

              '
            type: string
            example: v3
    TestResult:
      type: object
      properties:
        component_address:
          description: Address of the component running the test.
          type: string
          example: 10.230.94.21
        component_name:
          description: Name of the component running the test.
          type: string
          example: CT0
        description:
          description: What the test is doing.
          type: string
          example: Testing phonehome connectivity
        destination:
          description: The URI of the target server being tested.
          type: string
          example: ra.cloud-support.purestorage.com
        enabled:
          description: 'Whether the object being tested is enabled or not.

            Returns a value of `true` if the the service is enabled.

            Returns a value of `false` if the service is disabled.

            '
          type: boolean
          example: true
        result_details:
          description: Additional information about the test result.
          type: string
          example: Timeout connecting to phonehome endpoint
        success:
          description: 'Whether the object being tested passed the test or not.

            Returns a value of `true` if the specified test has succeeded.

            Returns a value of `false` if the specified test has failed.

            '
          type: boolean
        test_type:
          description: 'Displays the type of test being performed. The returned values are determined

            by the `resource` being tested and its configuration.

            Values include `array-admin-group-searching`, `binding`, `connecting`, `phonehome`,

            `phonehome-ping`, `remote-assist`, `rootdse-searching`, `read-only-group-searching`,

            `storage-admin-group-searching`, and `validate-ntp-configuration`.

            '
          type: string
          example: phonehome
    _resource:
      description: 'An ordinary (as opposed to built-in) resource that can be created, named,

        renamed or deleted by the user. This might be a virtual resource (e.g., a

        file system), or correspond to something in the environment, like a host or a

        server.

        '
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified and cannot refer to another resource.

            '
          type: string
          readOnly: true
        name:
          description: 'A user-specified name.

            The name must be locally unique and can be changed.

            '
          type: string
    TestResultResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TestResult_2'
    _fixedReferenceWithoutType:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
          readOnly: true
        name:
          description: 'The resource name, such as volume name, file system name,

            snapshot name, and so on.

            '
          type: string
          readOnly: true
      x-readOnly: true
    _errorcontextresponseErrors:
      type: object
      properties:
        context:
          description: 'Contains information relating to the cause of this error,

            or the name of the object that was being processed when the error was encountered.

            This may be `null` for more general errors.

            '
          type: string
        location_context:
          description: 'Contains information relating to the context in which the request was executing

            when the error occurred.

            For example, this may be the name of an array in the same fleet.

            This may be `null` for more general errors, or if no explicit `context` parameter

            was provided with the request.

            '
          title: FixedReferenceWithType
          allOf:
          - $ref: '#/components/schemas/_fixedReferenceWithType'
        message:
          description: A description of the error which occurred.
          type: string
          example: Resource does not exist.
      x-aliases:
      - _errorContextResponseErrors
    TestResultWithResource:
      allOf:
      - $ref: '#/components/schemas/TestResult'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          resource:
            description: A reference to the object being tested.
            title: FixedReferenceNoId
            allOf:
            - $ref: '#/components/schemas/_fixedReferenceNoId'
    _resourceNoId:
      description: 'An ordinary (as opposed to built-in) resource that can be created, named,

        renamed or deleted by the user. This might be a virtual resource (e.g., a

        volume), or correspond to something in the environment, like a host or a

        server.

        '
      type: object
      properties:
        name:
          description: 'A user-specified name.

            The name must be locally unique and can be changed.

            '
          type: string
    TestResultGetResponse:
      allOf:
      - $ref: '#/components/schemas/TestResultResponse'
      - type: object
        properties:
          total_item_count:
            description: Total number of items after applying `filter` params.
            type: integer
            format: int32
    _fixedReferenceWithType:
      allOf:
      - $ref: '#/components/schemas/_fixedReference'
      - type: object
        properties:
          resource_type:
            description: 'Type of the object (full name of the endpoint).

              Valid values are the unique part of the resource''s REST endpoint.

              For example, a reference to a file system would have a

              `resource_type` of `file-systems`.

              '
            type: string
            readOnly: true
      x-aliases:
      - _fixedReference
    _snmp_v3_2:
      description: 'The v3 configurations of SNMP.

        '
      type: object
      properties:
        auth_passphrase:
          description: 'Passphrase used by Purity to authenticate the array with the

            specified managers.

            '
          type: string
          example: '****'
        auth_protocol:
          description: 'Hash algorithm used to validate the authentication passphrase.

            Valid values are `MD5` and `SHA`.

            '
          type: string
          example: MD5
        privacy_passphrase:
          description: Passphrase used to encrypt SNMP messages.
          type: string
          example: '****'
        privacy_protocol:
          description: 'Encryption protocol for SNMP messages.

            Valid values are `AES` and `DES`.

            '
          type: string
          example: DES
        user:
          description: 'User ID recognized by the specified SNMP managers which Purity

            is to use in communications with them.

            '
          type: string
          example: User1
    _fixedReferenceNoId:
      type: object
      properties:
        name:
          description: 'The resource name,

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

            '
          type: string
          readOnly: true
      x-readOnly: true
    SnmpManagerResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SnmpManager'
    _snmp_v3_post:
      description: 'The v3 configurations of SNMP.

        '
      type: object
      properties:
        auth_passphrase:
          description: 'Passphrase used by Purity//FA to authenticate the array with the specified managers.

            '
          type: string
          maxLength: 32
          example: '********'
        auth_protocol:
          description: 'Hash algorithm used to validate the authentication passphrase.

            Valid values are `MD5` and `SHA`.

            '
          type: string
          example: MD5
        privacy_passphrase:
          description: Passphrase used to encrypt SNMP messages.
          type: string
          minLength: 8
          maxLength: 63
          example: '********'
        privacy_protocol:
          description: 'Encryption protocol for SNMP messages.

            Valid values are `AES` and `DES`.

            '
          type: string
          example: DES
        user:
          description: 'User ID recognized by the specified SNMP managers which Purity//FA

            is to use in communications with them.

            '
          type: string
          example: User1
    SnmpManagerPost:
      type: object
      properties:
        host:
          description: 'DNS hostname or IP address of a computer that hosts an SNMP manager

            to which Purity//FA is to send trap messages when it generates alerts.

            '
          type: string
          example: snmp.purestorage.com
        notification:
          description: 'The type of notification the agent will send.

            Valid values are `inform` and `trap`.

            '
          type: string
          example: trap
        v2c:
          $ref: '#/components/schemas/_snmp_v2c'
        v3:
          $ref: '#/components/schemas/_snmp_v3_post'
        version:
          description: 'Version of the SNMP protocol to be used by Purity//FA to communicate with the specified

            manager. Valid values are `v2c` and `v3`.

            '
          type: string
          example: v3
    TestResultWithResourceGetResponse:
      allOf:
      - $ref: '#/components/schemas/TotalItemCountResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/TestResultWithResource'
    SnmpManagerGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/SnmpManagerResponse'
    SnmpManager_2:
      allOf:
      - $ref: '#/components/schemas/_resource'
      - type: object
        properties:
          host:
            description: 'DNS hostname or IP address of a computer that hosts an SNMP manager

              to which Purity is to send trap messages when it generates alerts.

              '
            type: string
            example: snmp.purestorage.com
          notification:
            description: 'The type of notification the agent will send.

              Valid values are `inform` and `trap`.

              '
            type: string
            example: trap
          v2c:
            $ref: '#/components/schemas/_snmp_v2c_2'
          v3:
            $ref: '#/components/schemas/_snmp_v3_2'
          version:
            description: 'Version of the SNMP protocol to be used by Purity in communications

              with the specified manager.

              Valid values are `v2c` and `v3`.

              '
            type: string
            example: v3
    _snmp_v3:
      description: 'The v3 configurations of SNMP.

        '
      type: object
      properties:
        auth_passphrase:
          description: 'Passphrase used by Purity//FA to authenticate the array with the specified managers.

            '
          type: string
          example: '****'
        auth_protocol:
          description: 'Hash algorithm used to validate the authentication passphrase.

            Valid values are `MD5` and `SHA`.

            '
          type: string
          example: MD5
        privacy_passphrase:
          description: Passphrase used to encrypt SNMP messages.
          type: string
          example: '****'
        privacy_protocol:
          description: 'Encryption protocol for SNMP messages.

            Valid values are `AES` and `DES`.

            '
          type: string
          example: DES
        user:
          description: 'User ID recognized by the specified SNMP managers which Purity//FA

            is to use in communications with them.

            '
          type: string
          example: User1
    _context:
      type: object
      properties:
        context:
          description: 'The context in which the operation was performed.


            Valid values include a reference to any array which is a member of the same fleet

            or to the fleet itself.


            Other parameters provided with the request, such as names of volumes or snapshots,

            are resolved relative to the provided `context`.

            '
          readOnly: true
          title: FixedReferenceWithType
          allOf:
          - $ref: '#/components/schemas/_fixedReferenceWithType'
    _snmp_v2c_2:
      description: 'The v2c configurations of SNMP.

        '
      type: object
      properties:
        community:
          description: 'Manager community ID under which Purity is to communicate with

            the specified managers.

            '
          type: string
          maxLength: 32
          example: '****'
    _fixedReference_2:
      allOf:
      - $ref: '#/components/schemas/_fixedReferenceWithoutType'
      - type: object
        properties:
          resource_type:
            description: 'Type of the object (full name of the endpoint).

              Valid values are the unique part of the resource''s REST endpoint.

              For example, a reference to a file system would have a

              `resource_type` of `file-systems`.

              '
            type: string
            readOnly: true
    TotalItemCountResponse:
      type: object
      properties:
        total_item_count:
          description: 'The total number of records after applying all filter query parameters.

            The `total_item_count` will be calculated if and only if the corresponding

            query parameter `total_item_count` is set to `true`. If this query parameter

            is not set or set to `false`, a value of `null` will be returned.

            '
          type: integer
          format: int32
    _snmp_v3_patch:
      description: 'The v3 configurations of SNMP.

        '
      type: object
      properties:
        auth_passphrase:
          description: 'Passphrase used by Purity//FA to authenticate the array with the specified managers.

            '
          type: string
          maxLength: 32
          example: '********'
        auth_protocol:
          description: 'Hash algorithm used to validate the authentication passphrase.

            Valid values are `MD5` and `SHA`.

            '
          type: string
          example: MD5
        privacy_passphrase:
          description: Passphrase used to encrypt SNMP messages.
          type: string
          minLength: 8
          maxLength: 63
          example: '********'
        privacy_protocol:
          description: 'Encryption protocol for SNMP messages.

            Valid values are `AES` and `DES`.

            '
          type: string
          example: DES
        user:
          description: 'User ID recognized by the specified SNMP managers which Purity//FA

            is to use in communications with them.

            '
          type: string
          example: User1
    SnmpManagerPost_2:
      type: object
      properties:
        host:
          description: 'DNS hostname or IP address of a computer that hosts an SNMP manager

            to which Purity is to send trap messages when it generates alerts.

            '
          type: string
          example: snmp.purestorage.com
        notification:
          description: 'The type of notification the agent will send.

            Valid values are `inform` and `trap`.

            '
          type: string
          example: trap
        v2c:
          $ref: '#/components/schemas/_snmp_v2c_2'
        v3:
          $ref: '#/components/schemas/_snmp_v3_post_2'
        version:
          description: 'Version of the SNMP protocol to be used by Purity in communications

            with the specified manager.

            Valid values are `v2c` and `v3`.

            '
          type: string
          example: v3
    _fixedReference:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
          readOnly: true
        name:
          description: 'The resource name, such as volume name, file system name,

            snapshot name, and so on.

            '
          type: string
          readOnly: true
      x-readOnly: true
      x-aliases:
      - _fixedReferenceWithoutType
    TestResult_2:
      type: object
      properties:
        component_address:
          description: Address of the component running the test.
          type: string
          example: 10.230.94.21
        component_name:
          description: Name of the component running the test.
          type: string
          example: fm1
        description:
          description: What the test is doing.
          type: string
          example: Testing phonehome connectivity
        destination:
          description: The URI of the target server being tested.
          type: string
          example: ra.cloud-support.purestorage.com
        enabled:
          description: Is the service enabled or not?
          type: boolean
          example: true
        resource:
          description: A reference to the object being tested.
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference_2'
        result_details:
          description: Additional information about the test result.
          type: string
          example: Timeout connecting to phonehome endpoint
        success:
          description: 'Returns a value of `true` if the specified test succeeded.

            Returns a value of `false` if the specified test failed.

            '
          type: boolean
        test_type:
          description: 'Displays the type of test being performed. The returned values are determined

            by the `resource` being tested and its configuration.

            '
          type: string
          example: phonehome
    _snmp_v3_post_2:
      description: 'The v3 configurations of SNMP.

        '
      type: object
      properties:
        auth_passphrase:
          description: 'Passphrase used by Purity to authenticate the array with the

            specified managers.

            '
          type: string
          maxLength: 32
          example: '****'
        auth_protocol:
          description: 'Hash algorithm used to validate the authentication passphrase.

            Valid values are `MD5` and `SHA`.

            '
          type: string
          example: MD5
        privacy_passphrase:
          description: Passphrase used to encrypt SNMP messages.
          type: string
          minLength: 8
          maxLength: 63
          example: '****'
        privacy_protocol:
          description: 'Encryption protocol for SNMP messages.

            Valid values are `AES` and `DES`.

            '
          type: string
          example: DES
        user:
          description: 'User ID recognized by the specified SNMP managers which Purity

            is to use in communications with them.

            '
          type: string
          example: User1
    SnmpManager:
      allOf:
      - $ref: '#/components/schemas/_resourceNoId'
      - type: object
        properties:
          host:
            description: 'DNS hostname or IP address of a computer that hosts an SNMP manager

              to which Purity//FA is to send trap messages when it generates alerts.

              '
            type: string
            example: snmp.purestorage.com
          notification:
            description: 'The type of notification the agent will send.

              Valid values are `inform` and `trap`.

              '
            type: string
            example: trap
          v2c:
            $ref: '#/components/schemas/_snmp_v2c'
          v3:
            $ref: '#/components/schemas/_snmp_v3'
          version:
            description: 'Version of the SNMP protocol to be used by Purity//FA to communicate with the specified

              manager. Valid values are `v2c` and `v3`.

              '
            type: string
            example: v3
    PageInfo:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token`

            query param to get the next page of data.

            If you use the continuation token to page through data you

            are guaranteed to get all items exactly once regardless of

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

            the pagination then it may or may not be returned.

            The continuation token is generated if the limit is less

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

            (no sort is specified).

            '
          type: string
        more_items_remaining:
          description: 'Returns a value of `true` if subsequent items can be retrieved.

            '
          type: boolean
          example: false
        total_item_count:
          descript

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