Resource URL: /platform/<<version=3>>/protocols/nfs/nlm/sessions

    Overview: This resource applies the standard collection pattern to NSM
              clients.

     Methods: GET

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

Method GET: List all NSM clients (optionally filtered by either zone or IP)

       URL: GET /platform/<<version=3>>/protocols/nfs/nlm/sessions

Query arguments:
  sort=<string> The field that will be used for sorting.
    ip=<string> An IP address for which NSM has client records
limit=<integer> Return no more than this many results at once (see resume).
  zone=<string> Represents an extant auth zone
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.

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"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "clients": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Describes host/callback information for a NSM monitor entry", 
            "properties": {
              "notify_error": {
                "type": "string", 
                "description": "Last error recieved attempting to notify this client"
              }, 
              "node_ip": {
                "type": "string", 
                "description": "An IP address for which NSM has client records"
              }, 
              "host_type": {
                "enum": [
                  "client", 
                  "server", 
                  "reverse", 
                  "expired"
                ], 
                "type": "string", 
                "description": "The sort of host that this entry represents"
              }, 
              "hostname": {
                "type": "string", 
                "description": "The host being monitored"
              }, 
              "is_active": {
                "type": "boolean", 
                "description": "Whether or not the client is actively being monitored"
              }, 
              "delegates": {
                "items": {
                  "type": "integer"
                }, 
                "type": "array"
              }, 
              "last_modified": {
                "type": "integer", 
                "description": "Unix time in seconds that the client was last modified (monitored or unmonitored)"
              }, 
              "notify_last_attempt": {
                "type": "integer", 
                "description": "Unix time in seconds when we last attempted to notify this clients"
              }, 
              "notify_attempts_remaining": {
                "type": "integer", 
                "description": "Number of times we will attempt to notify this client before giving up"
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}
