Resource URL: /platform/<<version=3>>/protocols/ndmp/settings/global

    Overview: This resource exposes ndmp global settings.

     Methods: GET, PUT

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

Method GET: List global ndmp settings.

       URL: GET /platform/<<version=3>>/protocols/ndmp/settings/global

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": {
        "global": {
          "type": "object", 
          "properties": {
            "dma": {
              "enum": [
                "generic", 
                "atempo", 
                "bakbone", 
                "commvault", 
                "emc", 
                "symantec", 
                "tivoli", 
                "symantec-netbackup", 
                "symantec-backupexec"
              ], 
              "type": "string", 
              "description": "A unique identifier for the dma vendor."
            }, 
            "service": {
              "type": "boolean", 
              "description": "Property to enable/diable the NDMP service."
            }, 
            "msr_context_retention_duration": {
              "type": "integer", 
              "description": "Multi-Stream Restore context retention duration."
            }, 
            "bre_max_num_contexts": {
              "type": "integer", 
              "description": "Maximum number of BRE contexts."
            }, 
            "msb_context_retention_duration": {
              "type": "integer", 
              "description": "Multi-Stream Backup context retention duration."
            }, 
            "port": {
              "type": "integer", 
              "description": "The port to listen on."
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=3>>/protocols/ndmp/settings/global

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "dma": {
      "enum": [
        "generic", 
        "atempo", 
        "bakbone", 
        "commvault", 
        "emc", 
        "symantec", 
        "tivoli", 
        "symantec-netbackup", 
        "symantec-backupexec"
      ], 
      "type": "string", 
      "description": "A unique identifier for the dma vendor."
    }, 
    "service": {
      "type": "boolean", 
      "description": "Property to enable/diable the NDMP service."
    }, 
    "msr_context_retention_duration": {
      "type": "integer", 
      "description": "Multi-Stream Restore context retention duration."
    }, 
    "bre_max_num_contexts": {
      "type": "integer", 
      "description": "Maximum number of BRE contexts."
    }, 
    "msb_context_retention_duration": {
      "type": "integer", 
      "description": "Multi-Stream Backup context retention duration."
    }, 
    "port": {
      "type": "integer", 
      "description": "The port to listen on."
    }
  }
}

There is no JSON response body for this method.
