Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Cancel the disabled state set by RAS Scheduler
The ID of a RD Session Host server.
No Content
Disable logons and reconnections on RD Session Host with the specified ID.
The ID of a RD Session Host server.
No Content
Drain until reboot of the RD Session Host server with specified ID.
The ID of a RD Session Host server.
No Content
Invoke RD Session Host role installation on RD Session Host with the specified ID.
The ID of a RD Session Host server.
No Content
Cancel a pending reboot set by RAS Scheduler
The ID of a RD Session Host server.
No Content
Drain the RD Session Host server with specified ID.
The ID of a RD Session Host server.
No Content
Enable logons on the RD Session Host server with specified ID.
The ID of a RD Session Host server.
No Content
Reboot RD Session Host with the specified ID.
The ID of a RD Session Host server.
No Content
Invoke a shutdown on the RD Session Host server with specified ID.
The ID of a RD Session Host server.
No Content
Invoke the RD Session Host Session to send a message to the RD Session Host Session with specified Session ID.
The ID of a RD Session Host server.
Session ID of the Session to be sent a message.
RD Session Host Session
The message title for the session message.
The session message to be sent.
No Content
Delete a RD Session Host server from a site. The RD Session Host agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.
RD Session Host ID
If this parameter is included, the RD Session Host agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the RD Session Host agent from the server. If this parameter is omitted, your RAS admin username (and password) will be used by default.
The password of the account specified in the Username parameter.
No Content
Delete a Schedule Message by ID.
The ID of the Schedule setting for which to remove the message.
The ID of the message to remove.
No Content
Invoke the RD Session Host to send the kill command to a process with the specified ID.
The ID of a RD Session Host server.
RD Session Host Process ID of the RD Session Host Process to be killed.
No Content
Invoke the RD Session Host Session to send the Disconnect command to the RD Session Host Session with specified Session ID.
The ID of a RD Session Host server.
Session ID of the Session to be Disconnected.
No Content
Invoke the RD Session Host to send the LogOff command to the session with specified ID.
The ID of a RD Session Host server.
Session ID of the Session to be Logged Off.
No Content
Remove a Schedule setting.
The ID of a Schedule setting to remove.
No Content
Get a list of the schedule setting's target ids.
The ID of the Schedule setting for which to retrieve the target settings.
The Schedule settings.
Success
Retrieve Predefined Windows Components
Success
The Aliases of the predefined object
The Display Name of the predefined object
Component Name.
Retrieve Predefined Windows Services
Success
The Aliases of the predefined object
The Display Name of the predefined object
Service Name.
Removes Windows Component Custom From Optimization.
The ID of the optimization setting to remove the windows component custom.
Windows Componenct Custom Settings
Windows Component Name
No Content
Removes Windows Service Custom From Optimization.
The ID of the optimization setting to remove the windows Service custom.
Windows Service Custom Settings
Windows Service Name
No Content
Remove Registry Image Optimization Object.
Id Of the Optimization Settings to remove the registry object.
Registry Settings
Registry Id
No Content
Add a Schedule target setting.
The ID of the Schedule setting to modify.
The Schedule target settings.
The target RD Session Host server or server group Ids depending on the TargetType parameter.
Created
Remove a Schedule target setting.
The ID of the Schedule setting to modify.
The Schedule settings.
The target RD Session Host server or server group Ids depending on the TargetType parameter.
No Content
Retrieves FSLogix Office Container CCDLocation List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Office Container settings.
Success
Retrieves FSLogix Office Container VHDLocation List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Office Container settings.
Success
Retrieve FSLogix Profile Container CCDLocation List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
Retrieve FSLogix Profile Container Folder Inclusion List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
Retrieve FSLogix Profile Container VHDLocation List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
Retrieve FSLogix Profile Container Folder Exclusion List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
Retrieve FSLogix Profile Container User Exclusion List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Retrieve FSLogix Profile Container User Inclusion List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Remove the assigned application package.
ID for which to remove the assigned application package.
Assigned application package settings.
The name of the application package for which to remove the assigned packaged application. This must be the actual application package name used in the RAS farm.
No Content
Retrieves FSLogix Office Container User Exclusion List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Office Container settings.
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Remove a folder from the CCDLocation List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
CCDLocation configuration.
Specifies the 'CCDLocation' path to remove from the CCDLocation List.
No Content
Remove a folder from the VHDLocation List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
VHDLocation configuration.
Specifies the 'VHDLocation' path to remove from the VHDLocation List.
No Content
Remove a folder from the CCDLocation List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
CCDLocation configuration.
Specifies the 'CCDLocation' path to remove from the CCDLocation List.
No Content
Remove a folder from the Folder Inclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
Folder configuration.
Specifies the 'Folder' path to remove to the Include/Exclude Folder List.
No Content
Remove a folder from the VHDLocation List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
VHDLocation configuration.
Specifies the 'VHDLocation' path to remove from the VHDLocation List.
No Content
Remove a folder from the Folder Exclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
Folder configuration.
Specifies the 'Folder' path to remove to the Include/Exclude Folder List.
No Content
Remove a user from the User Inclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
User configuration.
The name of the user/group account to remove from the FSLogix Container.
The SID of the user/group account to remove from the FSLogix Container.
No Content
Remove a user from the User Exclusion List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
User configuration.
The name of the user/group account to remove from the FSLogix Container.
The SID of the user/group account to remove from the FSLogix Container.
No Content
Remove a user from the User Inclusion List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
User configuration.
The name of the user/group account to remove from the FSLogix Container.
The SID of the user/group account to remove from the FSLogix Container.
No Content
Remove a user from the User Exclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
User configuration.
The name of the user/group account to remove from the FSLogix Container.
The SID of the user/group account to remove from the FSLogix Container.
No Content
Retrieve Predefined Windows Scheduled Task
Success
Whether file type is a folder or a task.
Task Name.
Location
Update the assigned application package settings with the specified ID.
The ID for which to modify the assigned application package setting.
Assigned application package settings.
The name of the application package for which to change the version. This must be the actual application package name used in the RAS farm.
The new version of the application package. This must be the actual application package version used in the RAS farm.
No Content
Removes Windows Scheduled Task From Optimization.
The ID of the optimization setting to remove the windows scheduled task.
Windows Scheduled Task Settings
Scheduled Task
Scheduled Task Location
No Content
Retrieve Windows Scheduled Task
The ID of the optimization setting to retrieve the windows scheduled task.
Success
Scheduled Task
Scheduled Task Location
Whether file type is a folder or a task.
Add a folder to the CCDLocation List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
CCDLocation configuration.
Specifies the 'CCDLocation' path to add to the CCDLocation List.
Created
Add a folder to the VHDLocation List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
VHDLocation configuration.
Specifies the 'VHDLocation' path to add to the VHDLocation List.
Created
Add a folder to the CCDLocation List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
CCDLocation configuration.
Specifies the 'CCDLocation' path to add to the CCDLocation List.
Created
Retrieves FSLogix Office Container User Inclusion List of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Office Container settings.
Success
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Add a folder to the VHDLocation List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
VHDLocation configuration.
Specifies the 'VHDLocation' path to add to the VHDLocation List.
Created
Retrieve the setting of the assigned application package.
Retrieve the assigned application package by ID.
Success
Application version
Application version tag name
Application version tag ID
Assigned application package name
Retrieve a Schedule Message.
The ID of the Schedule setting for which to retrieve the message.
The ID of the message to retrieve.
Success
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Add a user to the User Inclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
User configuration.
The name of the user/group account to add to the FSLogix Container.
The SID of the user/group account to add to the FSLogix Container.
Created
Add a folder to the Folder Inclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
Folder configuration.
Specifies the 'Folder' path to add to the Include/Exclude Folder List.
Created
Add a user to the User Exclusion List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
User configuration.
The name of the user/group account to add to the FSLogix Container.
The SID of the user/group account to add to the FSLogix Container.
Created
Add a user to the User Inclusion List of the FSLogix Office Container settings.
The ID of a session server for which to modify the FSLogix Office Container settings.
User configuration.
The name of the user/group account to add to the FSLogix Container.
The SID of the user/group account to add to the FSLogix Container.
Created
Add a user to the User Exclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
User configuration.
The name of the user/group account to add to the FSLogix Container.
The SID of the user/group account to add to the FSLogix Container.
Created
Add an assigned application package.
The ID for which to add the assigned application package.
Assigned application package settings.
The application package name. This must be the actual application package name used in the RAS farm.
The version of the application package. This must be the actual application package version used in the RAS farm.
Created
Adds a Windows Scheduled task to optimization.
The ID of the Optimization settings to retrieve the windows scheduled task.
Windows Scheduled Task Settings.
Scheduled Task Name
Scheduled Task Location
Created
Retrieve the list of all processes for a specified session of a specified RDS.
Server ID for which processes of a specified RD Session Host session will be retrieved
Session ID for which all processes will be retrieved
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Retrieve a process with a specified PID for a specified session of a specified RD Session Host.
Server ID for which a process of a specified RD Session Host session will be retrieved
Session ID for which a specified process will be retrieved
ID of the process to be retrieved
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Retrieve Windows Service Custom
The ID of the optimization setting to retrieve the windows service custom list.
Success
Details Type
Windows Services Name
Windows Services Display Name
Windows Service Aliases
Retrieve the list of all processes for all the RD Session Host sessions.
Site ID for which processes for all the RD Session Host sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Retrieve the list of all processes for all the sessions of a specified RDS.
Server ID for which processes for all the RD Session Host sessions will be retrieved
Success
Published Item name.
Application name.
Process name.
Process ID.
User which is running the application.
RAS session ID.
Server ID from where the application is hosted.
Retrieve Windows Component Custom
The ID of the optimization setting to retrieve the windows component custom list.
Success
Details Type
Windows Components Name
Windows Components Display Name
Windows Components Aliases
Adds a Windows Component Custom to optimization.
The ID of the Optimization settings to add the windows component custom.
Windows Componenct Custom Settings.
Windows Components Alias
Windows Components Diplay Name
Windows Components Name
Created
Adds a Windows Service Custom to optimization.
The ID of the Optimization settings to add the windows services custom.
Windows Services Settings.
Windows Services Alias
Windows Services Diplay Name
Windows Service Name
Created
Retrieve Schedule Message(s).
The ID of the Schedule setting for which to retrieve the messages.
Success
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Modify an item in the folder exclusion list of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
Folder configuration.
Specifies the 'Folder' path to modify within Exclude Folder List.
Exclude Folder Copy values.
Created
Update a Schedule Message.
The ID of the Schedule setting for which to modify the message.
The ID of the message to modify.
Message settings.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
No Content
Add a folder to the Folder Exclusion List of the FSLogix Profile Container settings.
The ID of a session server for which to modify the FSLogix Profile Container settings.
Folder configuration.
Specifies the 'Folder' path to add to the Include/Exclude Folder List.
Exclude Folder Copy values.
Created
Create a Schedule Message.
The ID of the Schedule setting for which to create the message.
Message settings.
Whether to enable or disable the message.
The title of the message.
A message that should be sent to users before the job starts.
Time interval in seconds before the job starts when the message to users should be sent.
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Created
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Retrieves Registry.
The ID of the optimization setting to retrieve the registry.
Success
The Id of the registry
The action type for add registry entry
Registry Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Adds Registry to the optimization.
The ID of the optimization to retrieve the registry.
Registry Settings
The action type for add registry entry
Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Created
Modify properties of a Schedule setting.
The ID of the Schedule setting to modify.
Schedule settings
A new name for the scheduler job.
Whether to enable or disable the schedule.
Schedule description.
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
No Content
Retrieve information about a particular Schedule setting by ID.
The ID of the Schedule setting for which to retrieve the information.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new disable Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Startup Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Retrieve a list of RD Session Host servers with status information.
Site ID for which RD Session Host servers with status information will be retrieved (optional)
Filter the result by server name (optional)
Success
ID of RAS Agent.
ID of Site.
Agent State
RAS Status Type
Agent Version.
Server name.
Server Operating System.
Service start time.
System boot time.
Number of unhandled exceptions.
Id of the machine
RAS Log Level
CPU load percentage.
Memory load percentage.
Disk Read.
Disk Write.
Whether the object is enabled or not.
Specifies the preferred Connection Broker.
Number of active sessions.
Number of disconnected sessions.
Number of active connections.
The IP the agent is using.
Session Login Status on the Remote Desktop Service
User profile disk status
Pending Schedule Type
The Application Packages statuses.
The Application Package name.
Application Package Registration Status
Update the FSLogix General Settings of a session server with the specified ID.
The ID of a session server for which to modify the FSLogix General Settings.
FSLogix General Settings.
Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam recycle bin' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD compact disk' option is enabled or disabled.
Enable State values.
Specifies if the 'Cache directory' option is enabled or disabled.
Specifies the 'Cache directory'.
Specifies if the 'Write cache directory' option is enabled or disabled.
Specifies the 'Write cache directory'.
Specifies if the 'Proxy directory' option is enabled or disabled.
Specifies the 'Proxy directory'.
Specifies if the 'Silence ACL warning' option is enabled or disabled.
Enable State values.
Log enabled values.
FSLogix log level values.
Specifies the 'Log keeping period in days'. Default: '2'.
Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.
Specifies the 'Robocopy log path'.
Log specific components values.
No Content
Creates a new Reboot Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Creates a new Shutdown Schedule.
The Schedule settings.
Schedule name.
Site ID from which to retrieve the schedule.
Whether to enable or disable the schedule.
Schedule description.
Schedule type
Start time. Default: Now.
Duration in seconds.
Repeat Type
Repeat Specific Days
The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.
Whether to select the percentage or specific number of members to be started
Percentage of members to be started
Specific number of members to be started
Power On Assigned Pool Members
Whether to enable Drain Mode
Force server reboot after the specified time in seconds
Enforce schedule for currently inactive host
What action to take on Disable
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Retrieves the FSLogix General Settings of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix General Settings.
Success
FSLogix App Services Settings
Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam recycle bin' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD compact disk' option is enabled or disabled.
Enable State values.
FSLogix Cloud Cache General Settings
Specifies if the 'Cache directory' option is enabled or disabled.
Specifies the 'Cache directory'.
Specifies if the 'Write cache directory' option is enabled or disabled.
Specifies the 'Write cache directory'.
Specifies if the 'Proxy directory' option is enabled or disabled.
Specifies the 'Proxy directory'.
Specifies if the 'Silence ACL warning' option is enabled or disabled.
Enable State values.
FSLogix Logging Settings
Log enabled values.
FSLogix log level values.
Specifies the 'Log keeping period in days'. Default: '2'.
Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.
Specifies the 'Robocopy log path'.
Log specific components values.
Retrieve the RD Session Host status information for the server.
RD Session Host ID
Success
ID of RAS Agent.
ID of Site.
Agent State
RAS Status Type
Agent Version.
Server name.
Server Operating System.
Service start time.
System boot time.
Number of unhandled exceptions.
Id of the machine
RAS Log Level
CPU load percentage.
Memory load percentage.
Disk Read.
Disk Write.
Whether the object is enabled or not.
Specifies the preferred Connection Broker.
Number of active sessions.
Number of disconnected sessions.
Number of active connections.
The IP the agent is using.
Session Login Status on the Remote Desktop Service
User profile disk status
Pending Schedule Type
The Application Packages statuses.
The Application Package name.
Application Package Registration Status
Retrieve information about one or multiple Schedule setting.
Site ID from which to retrieve the Schedule setting (optional).
The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule setting name used in the RAS connections.
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Site ID
Schedule Object Type
Schedule Action Type
Scheduler Target Type
Enabled
Name
Description
Type
Target IDs
Target Native Hosts
Pool Id
GUID
Guest Name
Host Azure ID
Trigger
Start Date
End Date
Repeat Type
Repeat Specific Days
Duration
Complete In
Options
Pool Members Type
Percentage of members
Specific number of members to be started
Power On Assigned Pool Members
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.
Enable Drain Mode
Force server reboot after
Enforce schedule for currently inactive host
On Disable
Retrieve a list of sessions for a specified RDS.
RD Session Host ID
Success
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Retrieve the list of all sessions.
Site ID of which the sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Retrieve a specific session.
The ID of the RD Session Host server.
The ID of a specific session.
Success
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Flow Information.
Route Flow Hop Type.
IP.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Retrieve a specific RD Session Host by ID. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
RD Session Host ID
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
The direct address of the target RD Session Host server.
The RDSH RAS Template ID.
If true, default agent settings will be inherited.
If true, default printer settings will be inherited.
If true, default User Profile settings will be inherited.
If true, default desktop access settings will be inherited.
If true, default optimization settings will be inherited.
If true, default app package settings will be inherited.
The port number of RD Session Host agent.
Maximum number of session a RDS Host can have.
Disconnect active session after (in seconds). 0 - Never.
Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Specifies if 'Application Monitoring' option is enabled or disabled.
Specifies if 'Use RemoteApps if available' option is enables or disabled.
Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)
Drag and drop redirection values.
The preferred Connection broker ID.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Manage RDP transport protocol.
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
User Profile Technology values.
FXLogix Settings
FSLogix Profile Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
Specifies whether the 'Customize Profile Folders' is enabled or disabled.
Exclude Common Folders.
Specifies the 'Folder Inclusion List'.
Specifies the 'Folder Exclusion List'.
Specifies the 'Folder' path.
Exclude Folder Copy values.
FSLogix Profile Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
FSLogix Office Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
FSLogix Office Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Include Office Activation' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneDrive' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote UWP' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook Personalization' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Sharepoint' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Skype' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Teams' option is enabled or disabled.
Enable State values.
Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.
Mirror Local OST-VHD values.
Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.
Specifies the 'Number of Session VHDs to Keep'.
Specifies if the 'Outlook Folder Path' option is enabled or disabled.
Specifies the 'Outlook Folder Path'.
Specifies if the 'Refresh User Policy' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD Access Mode' option is enabled or disabled.
VHD Access Mode values.
FSLogix General Settings
FSLogix App Services Settings
Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam recycle bin' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD compact disk' option is enabled or disabled.
Enable State values.
FSLogix Cloud Cache General Settings
Specifies if the 'Cache directory' option is enabled or disabled.
Specifies the 'Cache directory'.
Specifies if the 'Write cache directory' option is enabled or disabled.
Specifies the 'Write cache directory'.
Specifies if the 'Proxy directory' option is enabled or disabled.
Specifies the 'Proxy directory'.
Specifies if the 'Silence ACL warning' option is enabled or disabled.
Enable State values.
FSLogix Logging Settings
Log enabled values.
FSLogix log level values.
Specifies the 'Log keeping period in days'. Default: '2'.
Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.
Specifies the 'Robocopy log path'.
Log specific components values.
User Profile Disk Mode.
Specifies the max user profile disk size (in GB).
Specifies the User Profile Disk path.
User Profile Disk Roaming Mode.
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
Image Optimization
Whether Optimization is enabled or not
Optimization Type
Image Optimization - Windows Defender ATP
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Image Optimization - Windows Components
Windows Components List
Details Type
Windows Components Name
Windows Components Display Name
Windows Components Aliases
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Image Optimization - Windows Services
Windows Services List
Details Type
Windows Services Name
Windows Services Display Name
Windows Service Aliases
Image Optimization - Windows Advanced Options
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Image Optimization - Network Performance
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether TCP is disabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Image Optimization - Custom Script
Arguments
Command
Initial Directory
User
Image Optimization - Disk Cleanup
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Image Optimization - Visual Effects
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings
The Windows Scheduled Tasks List
Scheduled Task
Scheduled Task Location
Whether file type is a folder or a task.
Image Optimization - Registries A list of Registries
The Registry List
The Id of the registry
The action type for add registry entry
Registry Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Image Optimization - UWPApps
All Except List
Following Pkgs List
Remove Type
Application Packages Assigned
List of Application Packages Assigned
Application version
Application version tag name
Application version tag ID
Assigned application package name
Update RD Session Host server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RD Session Host ID
RD Session Host settings
Enable or disable the specified RD Session Host server in a site.
A new server name. This must be either the server's FQDN or IP address.
A user-defined RD Session Host server description.
Specifies the RD Session Host server direct address.
Enable or disable the 'Inherit default agent settings' option. This will inherit RD Session Host agent settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default printer settings' option. This will inherit RD Session Host printer settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default user profile settings' option. This will inherit RD Session Host User Profile settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default desktop access settings' option. This will inherit RD Session Host Desktop Access settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default Optimization Settings' option. This will inherit Image Optimization settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default App Package Settings' option. This will inherit Application Packages from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Specifies the port number for the RD Session Host agent.
Specifies the 'Maximum Sessions' property.
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
URL and Mail Redirection values.
Enable or disable the 'Support Shell URL Namespace Objects' option.
Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
Enable or disable the 'Application Monitoring' option.
Enable or disable the 'Use RemoteApps if available' option.
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Drag and drop redirection values.
Manage RDP transport protocol.
Enables or disables Universal Printing on the RD Session Host server. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Enable or disable TWAIN (Universal Scanning) on the RD Session Host server. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Enable or disable WIA (Universal Scanning) on the RD Session Host server. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Enable or disable the 'Remove client name from printer name' option.
Enable or disable the 'Remove session number from printer name' option.
Set the 'Preferred Connection Broker' option to 'Automatically".
The preferred Connection Broker ID.
Enable or disable the 'Enable Drive Redirection Cache' option.
User Profile Technology values.
User Profile Disk Mode.
User Profile Disk Roaming Mode.
Specifies the User Profile Disk path.
Specifies the max user profile disk size (in GB).
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Enable or disable the 'Restrict direct desktop access to the following users' option. Use the RestrictedUsers parameter to specify the list of users.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
No Content
Retrieve a list of RD Session Host settings. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
Site ID for which to retrieve RD Session Host settings (optional)
Filter the result by server name (optional)
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
The direct address of the target RD Session Host server.
The RDSH RAS Template ID.
If true, default agent settings will be inherited.
If true, default printer settings will be inherited.
If true, default User Profile settings will be inherited.
If true, default desktop access settings will be inherited.
If true, default optimization settings will be inherited.
If true, default app package settings will be inherited.
The port number of RD Session Host agent.
Maximum number of session a RDS Host can have.
Disconnect active session after (in seconds). 0 - Never.
Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Specifies if 'Application Monitoring' option is enabled or disabled.
Specifies if 'Use RemoteApps if available' option is enables or disabled.
Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)
Drag and drop redirection values.
The preferred Connection broker ID.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Manage RDP transport protocol.
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
User Profile Technology values.
FXLogix Settings
FSLogix Profile Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
Specifies whether the 'Customize Profile Folders' is enabled or disabled.
Exclude Common Folders.
Specifies the 'Folder Inclusion List'.
Specifies the 'Folder Exclusion List'.
Specifies the 'Folder' path.
Exclude Folder Copy values.
FSLogix Profile Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
FSLogix Office Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
FSLogix Office Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Include Office Activation' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneDrive' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote UWP' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook Personalization' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Sharepoint' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Skype' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Teams' option is enabled or disabled.
Enable State values.
Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.
Mirror Local OST-VHD values.
Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.
Specifies the 'Number of Session VHDs to Keep'.
Specifies if the 'Outlook Folder Path' option is enabled or disabled.
Specifies the 'Outlook Folder Path'.
Specifies if the 'Refresh User Policy' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD Access Mode' option is enabled or disabled.
VHD Access Mode values.
FSLogix General Settings
FSLogix App Services Settings
Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam recycle bin' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD compact disk' option is enabled or disabled.
Enable State values.
FSLogix Cloud Cache General Settings
Specifies if the 'Cache directory' option is enabled or disabled.
Specifies the 'Cache directory'.
Specifies if the 'Write cache directory' option is enabled or disabled.
Specifies the 'Write cache directory'.
Specifies if the 'Proxy directory' option is enabled or disabled.
Specifies the 'Proxy directory'.
Specifies if the 'Silence ACL warning' option is enabled or disabled.
Enable State values.
FSLogix Logging Settings
Log enabled values.
FSLogix log level values.
Specifies the 'Log keeping period in days'. Default: '2'.
Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.
Specifies the 'Robocopy log path'.
Log specific components values.
User Profile Disk Mode.
Specifies the max user profile disk size (in GB).
Specifies the User Profile Disk path.
User Profile Disk Roaming Mode.
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
Image Optimization
Whether Optimization is enabled or not
Optimization Type
Image Optimization - Windows Defender ATP
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Image Optimization - Windows Components
Windows Components List
Details Type
Windows Components Name
Windows Components Display Name
Windows Components Aliases
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Image Optimization - Windows Services
Windows Services List
Details Type
Windows Services Name
Windows Services Display Name
Windows Service Aliases
Image Optimization - Windows Advanced Options
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Image Optimization - Network Performance
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether TCP is disabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Image Optimization - Custom Script
Arguments
Command
Initial Directory
User
Image Optimization - Disk Cleanup
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Image Optimization - Visual Effects
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings
The Windows Scheduled Tasks List
Scheduled Task
Scheduled Task Location
Whether file type is a folder or a task.
Image Optimization - Registries A list of Registries
The Registry List
The Id of the registry
The action type for add registry entry
Registry Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Image Optimization - UWPApps
All Except List
Following Pkgs List
Remove Type
Application Packages Assigned
List of Application Packages Assigned
Application version
Application version tag name
Application version tag ID
Assigned application package name
Update the Image Optimization settings with the specified ID.
The ID for which to modify the Image Optimization.
Image Optimization Settings.
Whether Optimization is Enabled or not
Optimization Type
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether Disable TCP is enabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Arguments
Command
Initial Directory
User
Password
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Force Optimization.
No Content
Retrieve Image Optimization Settings
Retrieve the Image Optimization by id
Success
Whether Optimization is enabled or not
Optimization Type
Image Optimization - Windows Defender ATP
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Image Optimization - Windows Components
Windows Components List
Details Type
Windows Components Name
Windows Components Display Name
Windows Components Aliases
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Image Optimization - Windows Services
Windows Services List
Details Type
Windows Services Name
Windows Services Display Name
Windows Service Aliases
Image Optimization - Windows Advanced Options
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Image Optimization - Network Performance
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether TCP is disabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Image Optimization - Custom Script
Arguments
Command
Initial Directory
User
Image Optimization - Disk Cleanup
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Image Optimization - Visual Effects
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings
The Windows Scheduled Tasks List
Scheduled Task
Scheduled Task Location
Whether file type is a folder or a task.
Image Optimization - Registries A list of Registries
The Registry List
The Id of the registry
The action type for add registry entry
Registry Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Image Optimization - UWPApps
All Except List
Following Pkgs List
Remove Type
Create a new RD Session Host server to a site. The RD Session Host agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.
Specifies not to install the RD Session Host agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the RD Session Host agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RD Session Host agent is installed. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RD Session Host Agent to communicate. If this parameter is omitted, the firewall rules will not be added.
Specifies not to install the Desktop Experience after the RD Session Host agent is installed. If this parameter is omitted, the Desktop Experience is installed.
Specifies not to install the Terminal Services role after the RD Session Host agent is installed. If this parameter is omitted, the Terminal Services role will be installed.
Specifies the list of users or groups in UPN or SID format to be added to the RDSUsers Group in csv format.
RD Session Host settings
A RD Session Host server FQDN or IP address.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
Specifies the list of users or groups in UPN or SID format to be added to the RDSUsers Group in csv format.
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
The direct address of the target RD Session Host server.
The RDSH RAS Template ID.
If true, default agent settings will be inherited.
If true, default printer settings will be inherited.
If true, default User Profile settings will be inherited.
If true, default desktop access settings will be inherited.
If true, default optimization settings will be inherited.
If true, default app package settings will be inherited.
The port number of RD Session Host agent.
Maximum number of session a RDS Host can have.
Disconnect active session after (in seconds). 0 - Never.
Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Specifies if 'Application Monitoring' option is enabled or disabled.
Specifies if 'Use RemoteApps if available' option is enables or disabled.
Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)
Drag and drop redirection values.
The preferred Connection broker ID.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Manage RDP transport protocol.
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
User Profile Technology values.
FXLogix Settings
FSLogix Profile Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
Specifies whether the 'Customize Profile Folders' is enabled or disabled.
Exclude Common Folders.
Specifies the 'Folder Inclusion List'.
Specifies the 'Folder Exclusion List'.
Specifies the 'Folder' path.
Exclude Folder Copy values.
FSLogix Profile Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
FSLogix Office Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
FSLogix Office Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Include Office Activation' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneDrive' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote UWP' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook Personalization' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Sharepoint' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Skype' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Teams' option is enabled or disabled.
Enable State values.
Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.
Mirror Local OST-VHD values.
Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.
Specifies the 'Number of Session VHDs to Keep'.
Specifies if the 'Outlook Folder Path' option is enabled or disabled.
Specifies the 'Outlook Folder Path'.
Specifies if the 'Refresh User Policy' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD Access Mode' option is enabled or disabled.
VHD Access Mode values.
FSLogix General Settings
FSLogix App Services Settings
Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam recycle bin' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD compact disk' option is enabled or disabled.
Enable State values.
FSLogix Cloud Cache General Settings
Specifies if the 'Cache directory' option is enabled or disabled.
Specifies the 'Cache directory'.
Specifies if the 'Write cache directory' option is enabled or disabled.
Specifies the 'Write cache directory'.
Specifies if the 'Proxy directory' option is enabled or disabled.
Specifies the 'Proxy directory'.
Specifies if the 'Silence ACL warning' option is enabled or disabled.
Enable State values.
FSLogix Logging Settings
Log enabled values.
FSLogix log level values.
Specifies the 'Log keeping period in days'. Default: '2'.
Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.
Specifies the 'Robocopy log path'.
Log specific components values.
User Profile Disk Mode.
Specifies the max user profile disk size (in GB).
Specifies the User Profile Disk path.
User Profile Disk Roaming Mode.
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
Image Optimization
Whether Optimization is enabled or not
Optimization Type
Image Optimization - Windows Defender ATP
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Image Optimization - Windows Components
Windows Components List
Details Type
Windows Components Name
Windows Components Display Name
Windows Components Aliases
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Image Optimization - Windows Services
Windows Services List
Details Type
Windows Services Name
Windows Services Display Name
Windows Service Aliases
Image Optimization - Windows Advanced Options
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Image Optimization - Network Performance
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether TCP is disabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Image Optimization - Custom Script
Arguments
Command
Initial Directory
User
Image Optimization - Disk Cleanup
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Image Optimization - Visual Effects
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings
The Windows Scheduled Tasks List
Scheduled Task
Scheduled Task Location
Whether file type is a folder or a task.
Image Optimization - Registries A list of Registries
The Registry List
The Id of the registry
The action type for add registry entry
Registry Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Image Optimization - UWPApps
All Except List
Following Pkgs List
Remove Type
Application Packages Assigned
List of Application Packages Assigned
Application version
Application version tag name
Application version tag ID
Assigned application package name
Retrieve the FSLogix Profile Container settings of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Profile Container settings.
Success
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
Specifies whether the 'Customize Profile Folders' is enabled or disabled.
Exclude Common Folders.
Specifies the 'Folder Inclusion List'.
Specifies the 'Folder Exclusion List'.
Specifies the 'Folder' path.
Exclude Folder Copy values.
FSLogix Profile Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
Retrieves the FSLogix Office Container settings of a session server with the specified ID.
The ID of a session server for which to retrieve the FSLogix Office Container settings.
Success
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
FSLogix Office Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Include Office Activation' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneDrive' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote UWP' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook Personalization' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Sharepoint' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Skype' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Teams' option is enabled or disabled.
Enable State values.
Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.
Mirror Local OST-VHD values.
Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.
Specifies the 'Number of Session VHDs to Keep'.
Specifies if the 'Outlook Folder Path' option is enabled or disabled.
Specifies the 'Outlook Folder Path'.
Specifies if the 'Refresh User Policy' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD Access Mode' option is enabled or disabled.
VHD Access Mode values.
Update the FSLogix Profile Container settings of a session server with the specified ID.
The ID of a session server for which to modify the FSLogix Profile Container settings.
FSLogix Profile Container settings.
Specifies if the Profile Container is enabled or disabled..
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CDD Locations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Enable or disable the 'Customize Profile Folders' option.
Exclude Common Folders.
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
No Content
Update the FSLogix Office Container settings of a session server with the specified ID.
The ID of a session server for which to modify the FSLogix Office Container settings.
FSLogix Office Container settings.
Specifies if the Office Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CDD Locations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Include Office Activation' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneDrive' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote UWP' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook Personalization' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Sharepoint' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Skype' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Teams' option is enabled or disabled.
Enable State values.
Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.
Mirror Local OST-VHD values.
Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.
Specifies the 'Number of Session VHDs to Keep'.
Specifies if the 'Outlook Folder Path' option is enabled or disabled.
Specifies the 'Outlook Folder Path'.
Specifies if the 'Refresh User Policy' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD Access Mode' option is enabled or disabled.
VHD Access Mode values.
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
No Content