netFolderServer Data Type

The metadata of a Net Folder Server

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
allow_client_initiated_sync boolean element 0/1 Flag indicating whether the desktop application can trigger the initial sync of home directory Net Folders.
auth_type string element 0/1 Strategy to use when authenticating to the file server.

Allowed values are:

  • kerberos
  • ntlm
  • kerberos_then_ntlm
driver_type string element 0/1 The type of server.

Can be one of:

  • windows_server
  • oes
  • oes2015
  • netware
  • share_point_2013
id long element 0/1 The ID of the Net Folder Server.
index_content boolean element 0/1 Flag indicating whether to index the content of files in the Net Folders.
jits_enabled boolean element 0/1 Flag indicating whether Just-in-Time synchronization is enabled.
jits_max_acl_age long element 0/1 Maximum age for ACL JITS results, in seconds.
jits_max_age long element 0/1 Maximum age for JITS results, in seconds.
last_modified dateTime element 0/1 Date and time when the Net Folder Server object was last modified.
name string element 0/1 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 element 0/1 Proxy user used to authenticate to the file server.

Ignored if proxy_use_identity==true
proxy_identity_id long element 0/1 Password for the proxy user.

Ignored if proxy_use_identity==false
proxy_password string element 0/1 Password for the proxy user.

Ignored if proxy_use_identity==true
proxy_use_identity boolean element 0/1 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 element 0/1 Base UNC path for this Net Folder Server.
sync_schedule schedule element 0/1 Synchronization schedule
Properties inherited from baseRestObject
href string element 0/1 The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<net_folder_server>
  <id>...</id>
  <name>...</name>
  <driver_type>...</driver_type>
  <only_sync_dirs>...</only_sync_dirs>
  <server_path>\\151.155.136.130\c\base</server_path>
  <proxy_dn>...</proxy_dn>
  <proxy_password>...</proxy_password>
  <proxy_use_identity>...</proxy_use_identity>
  <proxy_identity_id>...</proxy_identity_id>
  <last_modified>...</last_modified>
  <change_detection_mechanism>...</change_detection_mechanism>
  <auth_type>...</auth_type>
  <sync_schedule>
    <enabled>...</enabled>
    <when>...</when>
    <selected_days>
      <sun>...</sun>
      <mon>...</mon>
      <tue>...</tue>
      <wed>...</wed>
      <thu>...</thu>
      <fri>...</fri>
      <sat>...</sat>
    </selected_days>
    <at>
      <hour>...</hour>
      <minute>...</minute>
    </at>
    <every>
      <hour>...</hour>
      <minute>...</minute>
    </every>
  </sync_schedule>
  <index_content>...</index_content>
  <jits_enabled>...</jits_enabled>
  <jits_max_age>...</jits_max_age>
  <jits_max_acl_age>...</jits_max_acl_age>
  <allow_client_initiated_sync>...</allow_client_initiated_sync>
  <href>...</href>
  <links>
    <link>
      <href>...</href>
      <rel>...</rel>
    </link>
  </links>
</net_folder_server>