HostGroup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "HostGroup",
  "description": "HostGroup schema from FlashArray REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-group-schema.json",
  "allOf": [
    {
      "description": "An ordinary (as opposed to built-in) resource that can be created, named,\nrenamed or deleted by the user. This might be a virtual resource (e.g., a\nvolume), or correspond to something in the environment, like a host or a\nserver.\n",
      "type": "object",
      "properties": {
        "name": {
          "description": "A user-specified name.\nThe name must be locally unique and can be changed.\n",
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "context": {
          "description": "The context in which the operation was performed.\n\nValid values include a reference to any array which is a member of the same fleet\nor to the fleet itself.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n",
          "readOnly": true,
          "title": "FixedReferenceWithType",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReferenceWithType"
            }
          ]
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "connection_count": {
          "description": "The number of volumes connected to the host group.",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 3
        },
        "destroyed": {
          "description": "Returns a value of `true` if the host group has been destroyed\nwith its container realm and is pending eradication.\nThe `time_remaining` value displays the amount of time left\nuntil the destroyed host group is permanently eradicated.\nBefore the `time_remaining` period has elapsed, the destroyed host group\nwill be recovered if its container realm is recovered.\nOnce the `time_remaining` period has elapsed,\nthe host group is permanently eradicated and can no longer be recovered.\n",
          "type": "boolean",
          "readOnly": true
        },
        "host_count": {
          "description": "The number of hosts in the host group.",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 3
        },
        "is_local": {
          "description": "Returns a value of `true` if the host or host group belongs to the current array. Returns a value of `false` if the host or host group belongs to a remote array.",
          "type": "boolean",
          "readOnly": true
        },
        "qos": {
          "description": "Displays QoS limit information.\n",
          "title": "ContainerQosCeilings",
          "allOf": [
            {
              "$ref": "#/components/schemas/_containerQosCeilings"
            }
          ]
        },
        "space": {
          "description": "Displays provisioned (virtual) size and physical storage consumption\ninformation for the sum of all volumes connected to the specified host.\n",
          "title": "Space",
          "allOf": [
            {
              "$ref": "#/components/schemas/_space"
            }
          ]
        },
        "time_remaining": {
          "description": "The amount of time left until the destroyed host group is permanently eradicated,\nmeasured in milliseconds.\n",
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    }
  ]
}