SimpliVity

SimpliVity omnistack_clusters API

An omnistack_cluster is a logical grouping of systems that run the HPE OmniStack software. The user defines an omnistack_cluster to efficiently share resources across the systems.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/authentication/simplivity-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-omnistack-clusters-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/scopes/simplivity-scopes.yml

OpenAPI Specification

simplivity-omnistack-clusters-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: "This API enables the programmatic management of key components of an HPE SimpliVity configuration.\n\nTo access the API, request an authentication token by issuing an authentication request in the following form, where the username/password combination is a set of valid management credentials for the applicable hypervisor environment:\n\n     curl -k https://simplivity@<host>/api/oauth/token -d grant_type=password -d username=<user> -d password=<pass>\n\nThen, you can pass in the resulting access_token returned in each HTTP header using Authorization: Bearer token. For example:\n\n     curl -H \"Authorization: Bearer 0a08c809-17ff-479f-b0a8-aedd4d8305a0\"\n\nThe access_token times out after 10 minutes of inactivity and expires after 24 hours.\n\nMake sure to use TLS version 1.2 or greater.\n\nThere are a wide range of possible return values.  Below is a list of the most common return values. \n\n    200 \"OK\" ⁃ This indicates that the request and action has completed with no issues.\n    201 \"Created\" ⁃ This indicates that the request has completed and a new resource has been created.\n    202 \"Accepted\" ⁃ This indicates that the request has been accepted for processing but the processing has not\n                     completed. This is a typical return when a task is generated.\n    400 \"Bad Request\" ⁃ The request cannot or will not be proccessed.  Usually due to a missing required parameter\n                        or invalid data in the parameter.\n    401 \"Unauthorized\" ⁃ The request has not been applied because it lacks authentication credentials for the\n                         target resource.\n    404 \"Not Found\" ⁃ The requested target doesn't exist or has been deleted.\n    405 \"Method Not Allowed\" ⁃ The method being requested is not valid for the target it is being performed on.\n    408 \"Request Timeout\" ⁃ The response took too long.\n    500 \"Internal Server Error\" ⁃ Indicates that the server encountered an unexpected condition that prevented it\n                                  from fulfilling the request.\n\n<a href=\"https://developer.hpe.com/platform/hpe-simplivity/home\" class=\"\toggleEndpointList\" data-id=\"errors\">Click here for a complete list of return codes and response formats</a>\n\n"
  version: '1.25'
  title: HPE OmniStack REST backups omnistack_clusters API
  contact:
    name: Hewlett Packard Enterprise
  license:
    name: HPE OmniStack REST API
host: localhost
basePath: ''
tags:
- name: omnistack_clusters
  description: An omnistack_cluster is a logical grouping of systems that run the HPE OmniStack software. The user defines an omnistack_cluster to efficiently share resources across the systems.
paths:
  /omnistack_clusters:
    get:
      tags:
      - omnistack_clusters
      summary: Retrieves all defined omnistack_clusters on the system
      operationId: listClusters
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: show_optional_fields
        in: query
        description: 'An indicator that specifies the capacity metrics, time_zone, upgrade_state, and upgrade_task_id of the omnistack_cluster


          Note: These values are computed from various sources. Consequently, the retrieval of these values may adversely affect the response time of a request.'
        required: false
        type: boolean
        default: false
      - name: id
        in: query
        description: 'The unique identifier (UID) of the omnistack_clusters to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: name
        in: query
        description: 'The name of the omnistack_clusters to return


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        type: string
      - name: hypervisor_object_id
        in: query
        description: 'The unique identifier (UID) of the hypervisor-based instance associated with the objects to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: hypervisor_object_parent_id
        in: query
        description: 'The unique identifier (UID) of the hypervisor-based instance that contains the objects to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: hypervisor_object_parent_name
        in: query
        description: 'The name of the hypervisor-based instance that contains the objects to return


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        type: string
      - name: hypervisor_management_system_name
        in: query
        description: 'The name of the hypervisor-based instance associated with the omnistack_cluster


          Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
        required: false
        type: string
      - name: type
        in: query
        description: 'The type of omnistack_clusters to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: cluster_group_id
        in: query
        description: 'The unique identifiers (UIDs) of the cluster_groups associated with the omnistack_clusters to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: arbiter_address
        in: query
        description: 'The address of the Arbiter connected to the objects to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: arbiter_connected
        in: query
        description: "An indicator to show if the omnistack_cluster is connected to Arbiter\n\n Valid values:\n\nTrue: Only returns omnistack_clusters connected to Arbiters that you identified in arbiter_address\n\nFalse: Only returns omnistack_clusters not connected to Arbiters that you identified in arbiter_address"
        required: false
        type: boolean
      - name: arbiter_required
        in: query
        description: An indicator to show if an Arbiter is required in this omnistack_cluster
        required: false
        type: boolean
      - name: arbiter_configured
        in: query
        description: An indicator to show if an Arbiter is configured in this omnistack_cluster
        required: false
        type: boolean
      - name: fields
        in: query
        description: "A comma-separated list of fields to include in the returned objects\n\n Default: Returns all fields"
        required: false
        type: string
      - name: limit
        in: query
        description: 'A positive integer that represents the maximum number of results to return


          Default: 500'
        required: false
        type: integer
        default: 500
        format: int32
      - name: offset
        in: query
        description: 'A positive integer that directs the service to start returning the &lt;offset value&gt; instance, up to the limit


          Default: 0'
        required: false
        type: integer
        default: 0
        format: int32
      - name: case
        in: query
        description: 'An indicator that specifies if the filter and sort results use a case-sensitive or insensitive manner


          Valid values: sensitive or insensitive


          Default: sensitive'
        required: false
        type: string
        default: sensitive
        enum:
        - sensitive
        - insensitive
      - name: sort
        in: query
        description: The name of the field where the sort occurs
        required: false
        type: string
      - name: order
        in: query
        description: 'The sort order preference


          Valid values: ascending or descending


          Default: descending'
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/omnistack_cluster'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/time_zone_list:
    get:
      tags:
      - omnistack_clusters
      summary: Retrieves a list of all valid time zones
      operationId: getTimeZones
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      responses:
        '200':
          description: OK
          schema:
            type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/{clusterId}:
    get:
      tags:
      - omnistack_clusters
      summary: Retrieves the specified omnistack_cluster
      operationId: getCluster
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: clusterId
        in: path
        description: The unique identifier (UID) of the omnistack_cluster that you want to retrieve
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/omnistack_cluster'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/{clusterId}/connected_clusters:
    get:
      tags:
      - omnistack_clusters
      summary: Retrieves directly connected omnistack_clusters
      operationId: getConnectedClusters
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: clusterId
        in: path
        description: The unique identifier (UID) of the omnistack_cluster that you want to retrieve
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/omnistack_cluster'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/{clusterId}/metrics:
    get:
      tags:
      - omnistack_clusters
      summary: Retrieves throughput, IOPS, and latency data for the cluster
      operationId: getClusterPerfomance
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: clusterId
        in: path
        description: The unique identifier (UID) of the omnistack_cluster
        required: true
        type: string
      - name: time_offset
        in: query
        description: 'A time offset in seconds (from now) or a datetime, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)


          Default: 0'
        required: false
        type: string
        default: '0'
      - name: range
        in: query
        description: 'A range in seconds (the duration from the specified point in time)


          Default: 43200'
        required: false
        type: integer
        default: 43200
        format: int64
      - name: resolution
        in: query
        description: 'The resolution (SECOND, MINUTE, HOUR, or DAY)


          Default: MINUTE'
        required: false
        type: string
        default: MINUTE
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/analytics_info'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/{clusterId}/set_iwo:
    post:
      tags:
      - omnistack_clusters
      summary: Sets the IWO status of the omnistack_cluster
      operationId: enableClusterIWO
      consumes:
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.20+json
      - application/vnd.simplivity.v1.24+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: clusterId
        in: path
        description: The unique identifier (UID) of the omnistack_cluster
        required: true
        type: string
      - in: body
        name: enabled
        description: 'An indicator to show the status of IWO for the omnistack_cluster


          Valid values:


          True: IWO is enabled for the omnistack_cluster.


          False: IWO is disabled for the omnistack_cluster.'
        required: true
        schema:
          $ref: '#/definitions/enabled'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/{clusterId}/set_time_zone:
    post:
      tags:
      - omnistack_clusters
      summary: Sets the time zone of the omnistack_cluster
      operationId: setClusterTimeZone
      consumes:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: clusterId
        in: path
        description: The unique identifier (UID) of the omnistack_cluster
        required: true
        type: string
      - in: body
        name: time_zone
        description: 'time_zone: The time zone in case-sensitive region/locale format (for example, "America/New_York")'
        required: true
        schema:
          $ref: '#/definitions/set_time_zone'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/TaskMO'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /omnistack_clusters/{clusterId}/throughput:
    get:
      tags:
      - omnistack_clusters
      summary: Calculates the throughput between each pair of omnistack_clusters in the federation
      operationId: getClustersThroughput
      consumes:
      - application/json
      produces:
      - application/vnd.simplivity.v1.23+json
      - application/vnd.simplivity.v1.9+json
      - application/vnd.simplivity.v1.18+json
      - application/vnd.simplivity.v1.14+json
      - application/vnd.simplivity.v1.11+json
      - application/vnd.simplivity.v1.17+json
      - application/vnd.simplivity.v1.21+json
      - application/vnd.simplivity.v1.22+json
      - application/vnd.simplivity.v1.3+json
      - application/vnd.simplivity.v1.10+json
      - application/vnd.simplivity.v1.6+json
      - application/vnd.simplivity.v1.25+json
      - application/vnd.simplivity.v1.19+json
      - application/json
      - application/vnd.simplivity.v1.5+json
      - application/vnd.simplivity.v1.13+json
      - application/vnd.simplivity.v1.16+json
      - application/vnd.simplivity.v1.2+json
      - application/vnd.simplivity.v1.24+json
      - application/vnd.simplivity.v1.7+json
      - application/vnd.simplivity.v1.4+json
      - application/vnd.simplivity.v1.1+json
      - application/vnd.simplivity.v1+json
      - application/vnd.simplivity.v1.8+json
      - application/vnd.simplivity.v1.15+json
      - application/vnd.simplivity.v1.12+json
      - application/vnd.simplivity.v1.20+json
      parameters:
      - name: clusterId
        in: path
        description: The unique identifier (UID) of the omnistack_cluster
        required: true
        type: string
      - name: destination_id
        in: query
        description: 'The unique identifier (UID) of the omnistack_clusters to return


          Accepts: Single value, comma-separated list'
        required: false
        type: string
      - name: time_offset
        in: query
        description: 'A time offset in seconds (from now) or a datetime, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)


          Default: 0'
        required: false
        type: string
        default: '0'
      - name: range
        in: query
        description: 'A range in seconds (the duration from the specified point in time)


          Default: 43200'
        required: false
        type: integer
        default: 43200
        format: int64
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/omnistack_cluster_to_cluster_throughput'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
definitions:
  analytics_info:
    type: object
    required:
    - data_points
    - name
    properties:
      data_points:
        type: array
        description: The metrics data points
        items:
          $ref: '#/definitions/MetricsDataMO'
      name:
        type: string
        description: The name of the set of metrics (iops, throughput, latency)
    description: The metrics information
  AffectedObjectMO:
    type: object
    required:
    - object_id
    - object_type
    properties:
      object_id:
        type: string
        description: The unique identifier (UID) of the object affected by the completed task
      object_type:
        type: string
        description: The type of the object affected by the completed task (virtual_machine, datastore, omnistack_cluster, backup, host, policy, rule)
  MetricsRawDataMO:
    type: object
    required:
    - date
    - value
    properties:
      date:
        type: string
        description: The date for the set of metrics, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
      value:
        type: object
        description: A metrics result value
  MetricsDataMO:
    type: object
    required:
    - date
    - reads
    - writes
    properties:
      date:
        type: string
        description: The date for the set of metrics, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
      reads:
        type: integer
        format: int64
        description: The number of reads per second or latency (in microseconds) or throughput (in bytes per second)
      writes:
        type: integer
        format: int64
        description: The number of writes per second or latency (in microseconds) or throughput (in bytes per second)
  infosight_configuration:
    type: object
    properties:
      infosight_claim_tag:
        type: string
        description: The claim tag for the customer in HPE InfoSight
      infosight_enabled:
        type: boolean
        example: false
        description: The flag that indicates the HPE Omnistack host should transmit data to HPE InfoSight
      infosight_proxy_url:
        type: string
        description: The proxy server URL for HPE InfoSight to use
      infosight_registered:
        type: boolean
        example: false
        description: The flag that indicates the cluster is registered with the HPE InfoSight service
      infosight_tenant_name:
        type: string
        description: The tenant name for the customer in HPE InfoSight
    description: The current configuration of the HPE InfoSight service
  set_time_zone:
    type: object
    required:
    - time_zone
    properties:
      time_zone:
        type: string
        description: Sets the time zone of the omnistack_cluster
    description: Sets the time zone of the omnistack_cluster
  omnistack_cluster_throughput:
    type: object
    required:
    - average_throughput
    - data
    - date
    - destination_omnistack_cluster_hypervisor_object_parent_id
    - destination_omnistack_cluster_hypervisor_object_parent_name
    - destination_omnistack_cluster_id
    - destination_omnistack_cluster_name
    - source_omnistack_cluster_hypervisor_object_parent_id
    - source_omnistack_cluster_hypervisor_object_parent_name
    - source_omnistack_cluster_id
    - source_omnistack_cluster_name
    properties:
      average_throughput:
        type: integer
        format: int64
        description: The average total throughput (in bytes per second) from source to destination omnistack_cluster
      data:
        description: The data used in throughput calculations for the omnistack_cluster
        $ref: '#/definitions/cluster_throughput_data'
      date:
        type: string
        description: The date for the set of metrics, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
      destination_omnistack_cluster_hypervisor_object_parent_id:
        type: string
        description: The hypervisor-based instance ID of the parent of the destination omnistack_cluster
      destination_omnistack_cluster_hypervisor_object_parent_name:
        type: string
        description: The hypervisor-based instance name of the parent of the destination omnistack_cluster
      destination_omnistack_cluster_id:
        type: string
        description: The unique identifier (UID) of the destination omnistack_cluster
      destination_omnistack_cluster_name:
        type: string
        description: The name of the destination omnistack_cluster
      source_omnistack_cluster_hypervisor_object_parent_id:
        type: string
        description: The hypervisor-based instance ID of the parent of the source omnistack_cluster
      source_omnistack_cluster_hypervisor_object_parent_name:
        type: string
        description: The hypervisor-based instance name of the parent of the source omnistack_cluster
      source_omnistack_cluster_id:
        type: string
        description: The unique identifier (UID) of the source omnistack_cluster
      source_omnistack_cluster_name:
        type: string
        description: The name of the source omnistack_cluster
    description: Calculated throughput between source and destination omnistack_clusters
  omnistack_cluster:
    type: object
    required:
    - allocated_capacity
    - arbiter_address
    - arbiter_configured
    - arbiter_connected
    - arbiter_required
    - capacity_savings
    - cluster_feature_level
    - cluster_group_ids
    - compression_ratio
    - deduplication_ratio
    - efficiency_ratio
    - free_space
    - hypervisor_management_system
    - hypervisor_management_system_name
    - hypervisor_object_id
    - hypervisor_object_parent_id
    - hypervisor_object_parent_name
    - hypervisor_type
    - id
    - infosight_configuration
    - iwo_enabled
    - local_backup_capacity
    - members
    - name
    - remote_backup_capacity
    - stored_compressed_data
    - stored_uncompressed_data
    - stored_virtual_machine_data
    - type
    - used_capacity
    - used_logical_capacity
    - version
    properties:
      allocated_capacity:
        type: integer


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-omnistack-clusters-api-openapi.yml