General

Get

Retrieves the FSLogix General Settings of a session server with the specified ID.

GET/api/VDI/HostPool/{id}/FSLogix/General
Path parameters
id*integer (int32)

The ID of a session server for which to retrieve the FSLogix General Settings.

Response

Success

Body
appServicesAppServicesSettings (object)

FSLogix App Services Settings

cloudCacheGeneralCloudCacheGeneralSettings (object)

FSLogix Cloud Cache General Settings

loggingFSLogixLoggingSettings (object)

FSLogix Logging Settings

Request
const response = await fetch('/api/VDI/HostPool/{id}/FSLogix/General', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "appServices": {
    "useCleanupInvalidSessions": false,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": false,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": false,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "cloudCacheGeneral": {
    "useCacheDirectory": false,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": false,
    "writeCacheDirectory": "text",
    "useProxyDirectory": false,
    "proxyDirectory": "text",
    "useSilenceACLWarning": false,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "logging": {
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 0,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }
}

Update

Update the FSLogix General Settings of a session server with the specified ID.

PUT/api/VDI/HostPool/{id}/FSLogix/General
Path parameters
id*integer (int32)

The ID of a session server for which to modify the FSLogix General Settings.

Body

FSLogix General Settings.

useCleanupInvalidSessionsnullable boolean

Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.

cleanupInvalidSessionsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable
useRoamRecycleBinnullable boolean

Specifies if the 'Roam recycle bin' option is enabled or disabled.

roamRecycleBinEnableState (enum)

Enable State values.

0 = Disable,1 = Enable
useVHDCompactDisknullable boolean

Specifies if the 'VHD compact disk' option is enabled or disabled.

vhdCompactDiskEnableState (enum)

Enable State values.

0 = Disable,1 = Enable
useCacheDirectorynullable boolean

Specifies if the 'Cache directory' option is enabled or disabled.

cacheDirectorynullable string

Specifies the 'Cache directory'.

useWriteCacheDirectorynullable boolean

Specifies if the 'Write cache directory' option is enabled or disabled.

writeCacheDirectorynullable string

Specifies the 'Write cache directory'.

useProxyDirectorynullable boolean

Specifies if the 'Proxy directory' option is enabled or disabled.

proxyDirectorynullable string

Specifies the 'Proxy directory'.

useSilenceACLWarningnullable boolean

Specifies if the 'Silence ACL warning' option is enabled or disabled.

silenceACLWarningEnableState (enum)

Enable State values.

0 = Disable,1 = Enable
logEnabledFSLogixLogEnabled (enum)

Log enabled values.

0 = Disable,1 = Specific,2 = All
logLevelFSLogixLogLevel (enum)

FSLogix log level values.

0 = Debug,1 = Information,2 = Warning,3 = Error
logFileKeepingPeriodnullable integer (int32)

Specifies the 'Log keeping period in days'. Default: '2'.

logDirectorynullable string

Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.

robocopyLogPathnullable string

Specifies the 'Robocopy log path'.

logSpecificComponentsLogSpecificComponents (enum)

Log specific components values.

1 = ProfileConfigTool,2 = IEPlugin,4 = RuleEditor,8 = JavaRuleEditor,16 = FSLogixAgentService,32 = Profile,64 = JavaLauncher,128 = OfficeContainer,256 = RuleCompilation,512 = FontVisibility,1024 = Network,2048 = PrinterVisibility,4096 = ADSComputerGroup,8192 = DriverInterface,16384 = WindowsSearchRoaming,32768 = WindowsSearchPlugin,65536 = ProcessStartMonitor
Response

No Content

Request
const response = await fetch('/api/VDI/HostPool/{id}/FSLogix/General', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Other Resources

Feedback

© 2024 Parallels International GmbH. All rights reserved.