Resource URL: /platform/<<version=5>>/license/generate

    Overview: This resource generates a license activation file.

     Methods: GET

********************************************************************************

Method GET: Generate license activation file.

       URL: GET /platform/<<version=5>>/license/generate

Query arguments:
               action=<enum> Where <enum> is one of generate_activation,
                             license_list_only, download_activation.  enum:
                             license_list_only (default), generate_activation,
                             download_activation. Generate an activation file
                             or return a list of activated licenses. If
                             generating an activation file and no licenses are
                             specified, the default configuration is to
                             generate an activation file with the current set
                             of licensed features. download_activation returns
                             HTTP headers and the same XML content as seen in
                             the response activation.
licenses_to_include=<string> Licenses to include in activation file.
licenses_to_exclude=<string> Licenses to omit from activation file.
only_these_licenses=<string> Activate only the defined licenses. This setting
                             overrides all other license activation settings.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "hardware": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "tier": {
                "minLength": 1, 
                "type": "string", 
                "pattern": "^NONINF$|^NO_TIER$|^\\d+$", 
                "description": "OneFS hardware tier. Tier is a number, NONINF, or NO_TIER. NONINF indicates a non infinity tier. NO_TIER indicates a license that is not tier based.", 
                "maxLength": 50
              }, 
              "node_count": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Licensed number of nodes in this tier.", 
                "maximum": 2147483647
              }, 
              "drive_capacity": {
                "required": false, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Licensed terabyte (TB, 10^12 bytes) drive capacity allocated as storage associated with tier. Included if tier is not NONINF and license is not a base only license.", 
                "maximum": 2147483647
              }, 
              "nodes_with_seds_count": {
                "required": false, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Licensed number of nodes of this tier that contain self-encrypting drives. Included only if license is ONEFS and tier is not NONINF.", 
                "maximum": 2147483647
              }
            }
          }, 
          "type": "array", 
          "description": "Array of licenses included in activation file.", 
          "maxItems": 2147483647
        }, 
        "not_activated_license_list": {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "pattern": ".+", 
            "description": "A license not included in activation file.", 
            "maxLength": 50
          }, 
          "type": "array", 
          "description": "An array of licenses not included in activation file.", 
          "maxItems": 50
        }, 
        "activated_license_list": {
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "pattern": ".+", 
            "description": "A license included in activation file.", 
            "maxLength": 50
          }, 
          "type": "array", 
          "description": "Array of licenses included in activation file.", 
          "maxItems": 50
        }, 
        "activation": {
          "minLength": 1, 
          "type": "string", 
          "pattern": ".+", 
          "description": "Contents of licensing activation file.", 
          "maxLength": 2147483647
        }
      }
    }
  ]
}
