Resource URL: /platform/<<version=3>>/cluster/diagnostics/gather/settings

    Overview: This resource configures isi_gather_info.

     Methods: GET, PUT

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

Method GET: Get the default options for isi_gather_info.

       URL: GET /platform/<<version=3>>/cluster/diagnostics/gather/settings

There are no query arguments for this method.

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": {
        "ftp_upload_host": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate FTP host to upload to."
        }, 
        "gather_mode": {
          "enum": [
            "full", 
            "incremental"
          ], 
          "type": "string", 
          "description": "Set gather to full or incremental.", 
          "required": false
        }, 
        "ftp_upload_path": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate FTP path to upload to."
        }, 
        "esrs": {
          "required": false, 
          "type": "boolean", 
          "description": "Use ESRS for upload of gather."
        }, 
        "http_upload": {
          "required": false, 
          "type": "boolean", 
          "description": "Whether or not to use HTTP upload on completed gather."
        }, 
        "http_upload_proxy_port": {
          "required": false, 
          "minimum": 1, 
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Alternate port for proxy server", 
          "maximum": 65535
        }, 
        "ftp_upload_user": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP user for upload."
        }, 
        "http_upload_proxy": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Proxy to use for HTTP upload."
        }, 
        "upload": {
          "required": false, 
          "type": "boolean", 
          "description": "Upload gather to EMC."
        }, 
        "http_upload_path": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate path to write gather to."
        }, 
        "ftp_upload_proxy": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP proxy to use for upload."
        }, 
        "ftp_upload": {
          "required": false, 
          "type": "boolean"
        }, 
        "http_upload_host": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate HTTP Host to upload to."
        }, 
        "ftp_upload_mode": {
          "enum": [
            "both", 
            "passive", 
            "active"
          ], 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP upload mode.", 
          "required": false
        }, 
        "ftp_upload_proxy_port": {
          "required": false, 
          "minimum": 1, 
          "type": [
            "integer", 
            "null"
          ], 
          "description": "FTP proxy port to use for upload.", 
          "maximum": 65535
        }
      }
    }
  ]
}

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

Method PUT: Set the default options for isi_gather_info.

       URL: PUT /platform/<<version=3>>/cluster/diagnostics/gather/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "ftp_upload_host": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "Alternate FTP host to upload to."
    }, 
    "gather_mode": {
      "enum": [
        "full", 
        "incremental"
      ], 
      "type": "string", 
      "description": "Set gather to full or incremental.", 
      "required": false
    }, 
    "ftp_upload_path": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "Alternate FTP path to upload to."
    }, 
    "esrs": {
      "required": false, 
      "type": "boolean", 
      "description": "Use ESRS for upload of gather."
    }, 
    "http_upload": {
      "required": false, 
      "type": "boolean", 
      "description": "Whether or not to use HTTP upload on completed gather."
    }, 
    "http_upload_proxy_port": {
      "required": false, 
      "minimum": 1, 
      "type": [
        "integer", 
        "null"
      ], 
      "description": "Alternate port for proxy server", 
      "maximum": 65535
    }, 
    "ftp_upload_user": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "FTP user for upload."
    }, 
    "http_upload_proxy": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "Proxy to use for HTTP upload."
    }, 
    "upload": {
      "required": false, 
      "type": "boolean", 
      "description": "Upload gather to EMC."
    }, 
    "http_upload_path": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "Alternate path to write gather to."
    }, 
    "ftp_upload_proxy": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "FTP proxy to use for upload."
    }, 
    "ftp_upload": {
      "required": false, 
      "type": "boolean"
    }, 
    "http_upload_host": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "Alternate HTTP Host to upload to."
    }, 
    "ftp_upload_mode": {
      "enum": [
        "both", 
        "passive", 
        "active"
      ], 
      "type": [
        "string", 
        "null"
      ], 
      "description": "FTP upload mode.", 
      "required": false
    }, 
    "ftp_upload_pass": {
      "required": false, 
      "type": [
        "string", 
        "null"
      ], 
      "description": "FTP password for upload."
    }, 
    "ftp_upload_proxy_port": {
      "required": false, 
      "minimum": 1, 
      "type": [
        "integer", 
        "null"
      ], 
      "description": "FTP proxy port to use for upload.", 
      "maximum": 65535
    }
  }
}

PUT 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": {
        "ftp_upload_host": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate FTP host to upload to."
        }, 
        "gather_mode": {
          "enum": [
            "full", 
            "incremental"
          ], 
          "type": "string", 
          "description": "Set gather to full or incremental.", 
          "required": false
        }, 
        "ftp_upload_path": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate FTP path to upload to."
        }, 
        "esrs": {
          "required": false, 
          "type": "boolean", 
          "description": "Use ESRS for upload of gather."
        }, 
        "http_upload": {
          "required": false, 
          "type": "boolean", 
          "description": "Whether or not to use HTTP upload on completed gather."
        }, 
        "http_upload_proxy_port": {
          "required": false, 
          "minimum": 1, 
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Alternate port for proxy server", 
          "maximum": 65535
        }, 
        "ftp_upload_user": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP user for upload."
        }, 
        "http_upload_proxy": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Proxy to use for HTTP upload."
        }, 
        "upload": {
          "required": false, 
          "type": "boolean", 
          "description": "Upload gather to EMC."
        }, 
        "http_upload_path": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate path to write gather to."
        }, 
        "ftp_upload_proxy": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP proxy to use for upload."
        }, 
        "ftp_upload": {
          "required": false, 
          "type": "boolean"
        }, 
        "http_upload_host": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Alternate HTTP Host to upload to."
        }, 
        "ftp_upload_mode": {
          "enum": [
            "both", 
            "passive", 
            "active"
          ], 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP upload mode.", 
          "required": false
        }, 
        "ftp_upload_pass": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "FTP password for upload."
        }, 
        "ftp_upload_proxy_port": {
          "required": false, 
          "minimum": 1, 
          "type": [
            "integer", 
            "null"
          ], 
          "description": "FTP proxy port to use for upload.", 
          "maximum": 65535
        }
      }
    }
  ]
}
