NetFolderServer Data Type

The metadata of a Net Folder Server

Properties
name data type description
allow_client_initiated_sync boolean Flag indicating whether the desktop application can trigger the initial sync of home directory Net Folders.
auth_type string Strategy to use when authenticating to the file server.

Allowed values are:

  • kerberos
  • ntlm
  • kerberos_then_ntlm
driver_type string The type of server.

Can be one of:

  • windows_server
  • oes
  • oes2015
  • netware
  • share_point_2013
id number The ID of the Net Folder Server.
index_content boolean Flag indicating whether to index the content of files in the Net Folders.
jits_enabled boolean Flag indicating whether Just-in-Time synchronization is enabled.
jits_max_acl_age number Maximum age for ACL JITS results, in seconds.
jits_max_age number Maximum age for JITS results, in seconds.
last_modified number Date and time when the Net Folder Server object was last modified.
name string The name of the Net Folder Server.

The name must be unique and cannot be changed once the Net Folder Server has been created.
proxy_dn string Proxy user used to authenticate to the file server.

Ignored if proxy_use_identity==true
proxy_identity_id number Password for the proxy user.

Ignored if proxy_use_identity==false
proxy_password string Password for the proxy user.

Ignored if proxy_use_identity==true
proxy_use_identity boolean Flag indicating whether to use a Proxy Identity or a proxy usernama and password to authenticate to the file server.

If true, proxy_identity_id must be set. If false, proxy_dn and proxy_password must be set.
server_path string Base UNC path for this Net Folder Server.
sync_schedule Schedule Synchronization schedule
Properties inherited from BaseRestObject
href string The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
links array of Link Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

{
  "id" : 12345,
  "name" : "...",
  "driver_type" : "...",
  "only_sync_dirs" : true,
  "server_path" : "\\\\151.155.136.130\\c\\base",
  "proxy_dn" : "...",
  "proxy_password" : "...",
  "proxy_use_identity" : true,
  "proxy_identity_id" : 12345,
  "last_modified" : 12345.0,
  "change_detection_mechanism" : "...",
  "auth_type" : "...",
  "sync_schedule" : {
    "enabled" : true,
    "when" : "...",
    "selected_days" : {
      "sun" : true,
      "mon" : true,
      "tue" : true,
      "wed" : true,
      "thu" : true,
      "fri" : true,
      "sat" : true
    },
    "at" : {
      "hour" : 12345,
      "minute" : 12345
    },
    "every" : {
      "hour" : 12345,
      "minute" : 12345
    }
  },
  "index_content" : true,
  "jits_enabled" : true,
  "jits_max_age" : 12345,
  "jits_max_acl_age" : 12345,
  "allow_client_initiated_sync" : true,
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}