Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Policy Management/ Modifying a Policy Template

Updated on 2026-05-21 GMT+08:00

Modifying a Policy Template

Function

Modifies information about a specified policy template.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:policyGroups:updateTemplate

Write

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:policyGroups:updateTemplate	Write	-	-	-	-

URI

PATCH /v1/{project_id}/policy-templates/{policy_template_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
policy_template_id	Yes	String	Policy template ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
policy_group	Yes	PolicyTemplate object	Policy template

**Table 4** PolicyTemplate
Parameter	Mandatory	Type	Description
policy_group_name	Yes	String	Policy group name. Requirements: Cannot start with a space or period (.). The value can contain digits, uppercase and lowercase letters. Contain 1 to 55 characters.
description	No	String	Description.
policies	Yes	Policies object	Policies

**Table 5** Policies
Parameter	Mandatory	Type	Description
peripherals	No	peripherals object	Peripherals
audio	No	audio object	Audio
client	No	client object	Client
display	No	display object	Display
file_and_clipboard	No	file_and_clipboard object	File & Clipboard
session	No	Session object	Session
virtual_channel	No	VirtualChannel object	Virtual channel
keyboard_mouse	No	keyboard_mouse object	Keyboard & Mouse
bandwidth	No	Bandwidth object	Bandwidth
custom	No	custom object	Custom policy
cloud_storage	No	cloud_storage object	Cloud storage configuration.
user_profile	No	user_profile object	Profile roaming.
url_redirection	No	url_redirection object	Configures URL redirection.
folder_redirection	No	folder_redirection object	Configures folder redirection.
folder_redirection_v2	No	folder_redirection_v2 object	Folder redirection (v2) configuration.
user_profile_management	No	user_profile_management object	User configuration policy.

**Table 6** peripherals
Parameter	Mandatory	Type	Description
usb_port_redirection	No	usb_port_redirection object	USB port redirection.
device_redirection	No	device_redirection object	Device redirection.
usb_device_common	No	usb_device_common object	USB and device smartcard options.
serial_port_redirection	No	serial_port_redirection object	Serial port redirection

**Table 7** usb_port_redirection
Parameter	Mandatory	Type	Description
usb_enable	No	Boolean	Indicates whether to enable USB port redirection. Options: false: no true: yes
options	No	UsbPortRedirectionOptions object	USB port redirection options.

**Table 8** UsbPortRedirectionOptions
Parameter	Mandatory	Type	Description
usb_image_enable	No	Boolean	Indicates whether to enable image devices, such as a scanner. Options: false: no; true: yes.
usb_video_enable	No	Boolean	Indicates whether to enable video devices, such as cameras. Options: false: no; true: yes.
usb_printer_enable	No	Boolean	Indicates whether to enable print devices, such as a printer. Options: false: no; true: yes.
usb_storage_enable	No	Boolean	Indicates whether to enable storage devices, such as USB flash drives. Options: false: no; true: yes.
wireless_devices_enable	No	Boolean	Indicates whether to enable wireless connections, such as Bluetooth. Options: false: no; true: yes.
network_devices_enable	No	Boolean	Indicates whether to enable network devices, such as a wireless NIC. Options: false: no; true: yes.
usb_smart_card_enable	No	Boolean	Indicates whether to enable smartcard devices, such as USB keys. Options: false: no; true: yes.
other_usb_devices_enable	No	Boolean	Indicates whether to enable the redirection of other USB devices. Options: false: no; true: yes.
usb_redirection_customization_policy	No	String	Customized USB port redirection policy
usb_redirection_mode	No	String	USB redirection mode. Options: Classical mode Common mode

**Table 9** device_redirection
Parameter	Mandatory	Type	Description
printer_redirection	No	printer_redirection object	Printer redirection
session_printer	No	session_printer object	Session printer
camera_redirection	No	camera_redirection object	Camera redirection.
twain_redirection_enable	No	Boolean	Indicates whether to enable TWAIN device redirection. Options: false: no; true: yes.
image_compression_level	No	String	Image compression level. Options: none: no compression low: highest speed medium: medium speed high: lowest speed lossless low-loss medium-loss high-loss

**Table 10** printer_redirection
Parameter	Mandatory	Type	Description
printer_enable	No	Boolean	Specifies whether to enable printer redirection. Options: false: no; true: yes;
options	No	PrinterRedirectionOptions object	Printer redirection options.

**Table 11** PrinterRedirectionOptions
Parameter	Mandatory	Type	Description
sync_client_default_printer_enable	No	Boolean	Specifies whether to enable the synchronization of the default client printer. Options: false: no; true: yes.
universal_printer_driver	No	String	Universal printer driver. Options:- Default: Universal Printing for Linux- PS: HDP XPSDrv Driver for windows- HDP XPSDrv Driver- Universal Printing PCL 5- Universal Printing PCL 6- Universal Printing PS

**Table 12** session_printer
Parameter	Mandatory	Type	Description
session_printer_enable	No	Boolean	Indicates whether to enable session printer. Options: false: no; true: yes.
options	No	SessionPrinterOptions object	Session printer options

**Table 13** SessionPrinterOptions
Parameter	Mandatory	Type	Description
session_printer_customization_policy	No	String	Session printer custom policy

**Table 14** camera_redirection
Parameter	Mandatory	Type	Description
video_compress_enable	No	Boolean	Indicates whether to enable camera redirection. Options: false: no; true: yes.
options	No	CameraRedirectionOptions object	Camera redirection options.

**Table 15** CameraRedirectionOptions
Parameter	Mandatory	Type	Description
camera_frame_rate	No	Integer	Camera frame rate (FPS). The value ranges from 1 to 30. Default value: 15
camera_max_width	No	Integer	Camera maximum width (pixel). The value ranges from 1 to 9999. Default value: 3000
camera_max_heigth	No	Integer	Camera maximum height (pixel). The value ranges from 1 to 9999. Default value: 3000
camera_compression_method	No	String	Camera data compression method. The value is H.264.

**Table 16** usb_device_common
Parameter	Mandatory	Type	Description
pcsc_smart_card_enable	No	String	Indicates whether to enable PC/SC smartcard redirection. Options: Enable Closed Disable
common_options	No	common_options object	Options for both USB and device smartcard.

**Table 17** common_options
Parameter	Mandatory	Type	Description
remove_smart_card_disconnect_enable	No	Boolean	Indicates whether to enable smartcard removal to log out of user sessions. Options: false: no; true: yes.

**Table 18** serial_port_redirection
Parameter	Mandatory	Type	Description
serial_port_enable	No	Boolean	Specifies whether to enable serial port redirection. Options: false: no; true: yes.
options	No	SerialPortRedirectionOptions object	Serial port redirection options.

**Table 19** SerialPortRedirectionOptions
Parameter	Mandatory	Type	Description
auto_connect_enable	No	Boolean	Indicates whether to enable automatic connection to client serial ports. Options: false: no; true: yes.

**Table 20** audio
Parameter	Mandatory	Type	Description
audio_redirection_enable	No	Boolean	Indicates whether to enable audio redirection. Options: false: no; true: yes.
play_redirection_enable	No	Boolean	Indicates whether to enable playback redirection. Options: false: no; true: yes.
play_classification	No	String	Play scenarios. Options: Lossless Speech Call Music Play Automatic Identification
record_redirection_enable	No	Boolean	Indicates whether to enable recording redirection. Options: false: no; true: yes.
record_classification	No	String	Recording scenarios. Options: Lossless Speech Call Music Record Automatic Identification

**Table 21** client
Parameter	Mandatory	Type	Description
automatic_reconnection_interval	No	Integer	Automatic reconnection interval (s). The value ranges from 1 to 50. Default value: 5
session_persistence_time	No	Integer	Session persistence time (s). The value ranges from 0 to 180. Default value: 180
forbid_screen_capture	No	Boolean	Indicates whether to enable the screen capture prevention policy. Options: false: no true: yes

**Table 22** display
Parameter	Mandatory	Type	Description
display_level	No	String	Specifies the display level. Options: LEVEL 1 LEVEL 2 LEVEL 3 LEVEL 4 (default/recommended) LEVEL 5
options	No	DisplayOptions object	Display level options.
rendering_acceleration_enable	No	Boolean	Indicates whether to enable rendering acceleration. Options: false: no; true: yes.
rendering_acceleration_options	No	rendering_acceleration_options object	Rendering acceleration options.
video_card_memory_size	No	Integer	GPU card cache (MB). The value ranges from 0 to 64. Default value: 64
driver_delegation_mode_enable	No	Boolean	Indicates whether to enable the driver hosting mode. Options: false: no; true: yes.
driver_delegation_latency	No	Integer	Driver delegation delay (*30 ms). The value ranges from 1 to 100. Default value: 80
video_latency	No	Integer	Video Latency (*30 ms). The value ranges from 1 to 100. Default value: 80
change_resolution_vm	No	Boolean	Indicates whether to enable computer resolution change. Options: false: no true: yes

**Table 23** DisplayOptions
Parameter	Mandatory	Type	Description
display_bandwidth	No	Integer	Bandwidth (kbit/s). The value ranges from 256 to 25000. Default value: 20000
frame_rate	No	Integer	Frame rate (FPS). The value ranges from 1 to 60. Default value: 25
video_frame_rate	No	Integer	Video frame rate (FPS). The value ranges from 1 to 60. Default value: 30
min_image_cache	No	Integer	Minimum capacity for image cache (MB). The value ranges from 0 to 300. Default value: 200
smoothing_factor	No	Integer	Lossy compression recognition threshold. The value ranges from 0 to 255. Default value: 60
lossless_compression_mode	No	String	Lossless compression mode. Options: Basic Compression Deep Compression
deep_compression_options	No	deep_compression_options object	Deep compression options.
lossy_compression_quality	No	Integer	Lossy compression quality. The value ranges from 20 to 100. Default value: 85
color_enhancement_enable	No	Boolean	Indicates whether to enable color enhancement in office scenarios. Options: false: no true: yes
quality_bandwidth_first	No	String	Quality/Bandwidth first. Options: Quality First: indicates basic compression. Bandwidth First: indicates deep compression.
video_bit_rate_options	No	video_bit_rate_options object	Video bitrate options.
peak_video_bit_rate	No	Integer	Peak video bitrate (kbit/s). The value ranges from 256 to 100000. Default value: 18000
video_quality_options	No	video_quality_options object	Video quality options.
gop_size	No	Integer	GOP size. The value ranges from 0 to 65535. Default value: 100
encoding_preset	No	String	Encoding preset. Options: Preset 1 Preset 2 Preset 3 Preset 4 Preset 5 Preset 6 Preset 7

**Table 24** deep_compression_options
Parameter	Mandatory	Type	Description
deep_compression_level	No	String	Deep compression level. Options: Level 0 Level 1 Level 2 Level 3 Level 4 Level 5 Level 6 Level 7 Level 8 Level 9

**Table 25** video_bit_rate_options
Parameter	Mandatory	Type	Description
average_video_bit_rate	No	Integer	Average video bitrate (kbit/s). The value ranges from 256 to 100000. Default value: 18000

**Table 26** video_quality_options
Parameter	Mandatory	Type	Description
average_video_quality	No	Integer	Average video quality. The value ranges from 5 to 59. Default value: 15
lowest_video_quality	No	Integer	Lowest video quality. The value ranges from 5 to 69. Default value: 25
highest_video_quality	No	Integer	Highest video quality. The value ranges from 1 to 59. Default value: 7

**Table 27** rendering_acceleration_options
Parameter	Mandatory	Type	Description
video_acceleration_enhancement_enable	No	Boolean	Indicates whether to enable video acceleration enhancement configuration. Options: false: no; true: yes.
video_optimization_enable	No	Boolean	Indicates whether to enable video scenario optimization. Options: false: no; true: yes.
gpu_color_optimization_enable	No	Boolean	Indicates whether to enable GPU color optimization. Options: false: no; true: yes.

**Table 28** file_and_clipboard
Parameter	Mandatory	Type	Description
bypass_in_remote_app_enable	No	Boolean	Indicates whether to enable two-way bypass in the application aggregation scenario. Options: false: no true: yes
file_redirection	No	file_redirection object	File redirection
fd_mobile_client_redir_enable	No	Boolean	Specifies whether to enable mobile client file redirection. Options: false: no true: yes
clipboard_redirection	No	String	Specifies the clipboard redirection. Options: DISABLED (default) SERVER_TO_CLIENT_ENABLED: indicates that clipboard redirection from the server to the client is enabled. CLIENT_TO_SERVER_ENABLED: indicates that clipboard redirection from the client to the server is enabled. TWO_WAY_ENABLED: indicates that two-way clipboard redirection is enabled.
clipboard_redirection_options	No	clipboard_redirection_options object	Clipboard redirection options.

**Table 29** file_redirection
Parameter	Mandatory	Type	Description
redirection_mode	No	String	File redirection. Options: DISABLED (default) READ_ONLY READ_AND_WRITE: indicates that files are readable and writable.
options	No	FileRedirectionOptions object	File redirection options.
vm_send_file_client	No	Boolean	Indicates whether to enable the function of sending files from the VM to the client. Options: false: no; true: yes.
redirection_send_file_options	No	redirection_send_file_options object	Options for both redirection and file sending.

**Table 30** FileRedirectionOptions
Parameter	Mandatory	Type	Description
fluid_control_switch_enable	No	Boolean	Indicates whether to enable the rate limit function. Options: false: no; true: yes.
fluid_control_options	No	fluid_control_options object	Rate limit options.
compression_switch_enable	No	Boolean	Indicates whether to enable the compression function. Options: false: no; true: yes.
compression_switch_options	No	compression_switch_options object	Compression switch options.
linux_file_size_supported_enable	No	Boolean	Indicates whether to enable the function of setting the file size in Linux. Options: false: no; true: yes.
linux_file_size_supported_options	No	linux_file_size_supported_options object	Options for setting the file size in Linux.
linux_root_mount_switch_enable	No	Boolean	Indicates whether to enable root directory mount in Linux. Options: false: no; true: yes.
linux_root_dir_list	No	String	Mount path of the Linux root directory. Default value: \home
linux_file_mount_path	No	String	Linux file system mount path. Default value: \media\|\Volumes\|\swdb\mnt\|\home\|\storage\|\tmp\|\run\media
linux_fixed_drive_file_system_format	No	String	Linux fixed driver file system format.
linux_removable_drive_file_system_format	No	String	Linux removable driver file system format. Default value: vfat\|ntfs\|msdos\|fuseblk\|sdcardfs\|exfat\|fuse.fdredir
linux_cdrom_drive_file_system_format	No	String	Linux CD-ROM driver file system format. Default value: cd9660\|iso9660\|udf
linux_network_drive_file_system_format	No	String	Linux network driver file system format. Default value: smbfs\|afpfs\|cifs
path_separator	No	String	Path separator. Default value: \|
fixed_drive_enable	No	Boolean	Indicates whether to enable fixed drives (such as local disks). Options: false: no; true: yes.
removable_drive_enable	No	Boolean	Specifies whether to enable removable drives (such as USB flash drives). Options: false: no; true: yes.
cd_rom_drive_enable	No	Boolean	Indicates whether to enable the CD-ROM driver. Options: false: no; true: yes.
network_drive_enable	No	Boolean	Indicates whether to enable the network driver. Options: false: no; true: yes.

**Table 31** fluid_control_options
Parameter	Mandatory	Type	Description
good_network_latency	No	Integer	Good network latency threshold (ms). The value ranges from 1 to 1000. Default value: 30
normal_network_latency	No	Integer	Normal network latency threshold (ms). The value ranges from 1 to 1000. Default value: 70
poor_network_latency	No	Integer	Poor network latency threshold (ms). The value ranges from 1 to 1000. Default value: 100
reducing_step	No	Integer	Reducing step (KB). The value ranges from 1 to 100. Default value: 20
slow_increasing_step	No	Integer	Slow increasing step (KB). The value ranges from 1 to 100. Default value: 10
quick_increasing_step	No	Integer	Quick increasing step (KB). The value ranges from 1 to 100. Default value: 20
start_speed	No	Integer	Start speed (KB/s). The value ranges from 1 to 10240. Default value: 1024
test_block_size	No	Integer	Test block size (KB). The value ranges from 64 to 1024. Default value: 64
test_time_gap	No	Integer	Test time gap (ms). The value ranges from 1000 to 100000. Default value: 10000

**Table 32** compression_switch_options
Parameter	Mandatory	Type	Description
compression_threshold	No	Integer	Compression threshold (byte). The value ranges from 0 to 10240. Default value: 512
minimum_compression_rate	No	Integer	Minimum compression rate. The value ranges from 0 to 1000. Default value: 900

**Table 33** linux_file_size_supported_options
Parameter	Mandatory	Type	Description
linux_file_size_supported_threshold	No	Integer	File size threshold supported by Linux (Byte). The value ranges from 0 to 4096. Default value: 100

**Table 34** redirection_send_file_options
Parameter	Mandatory	Type	Description
read_write_speed	No	Integer	Read write speed (kbit/s). The value ranges from 0 to 2147483647. Default value: 0

**Table 35** clipboard_redirection_options
Parameter	Mandatory	Type	Description
rich_text_redirection_enable	No	Boolean	Indicates whether to enable clipboard rich text redirection. Options: false: no; true: yes.
rich_text_clipboard_redirection	No	String	Clipboard rich text redirection. Options: DISABLED (default) SERVER_TO_CLIENT_ENABLED: indicates that clipboard redirection from the server to the client is enabled. CLIENT_TO_SERVER_ENABLED: indicates that clipboard redirection from the client to the server is enabled. TWO_WAY_ENABLED: indicates that two-way clipboard redirection is enabled.
clipboard_file_redirection_enable	No	Boolean	Specifies whether to enable clipboard file redirection. Options: false: no; true: yes.
file_clipboard_redirection	No	String	Clipboard file redirection. Options: DISABLED (default) SERVER_TO_CLIENT_ENABLED: indicates that clipboard redirection from the server to the client is enabled. CLIENT_TO_SERVER_ENABLED: indicates that clipboard redirection from the client to the server is enabled. TWO_WAY_ENABLED: indicates that two-way clipboard redirection is enabled.
clipboard_length_limit_cts_enable	No	Boolean	Whether to limit the character length for clipboard redirection from local devices to VMs. Options: false: no true: yes
clipboard_length_limit_cts	No	Integer	Maximum number of characters for clipboard redirection from local devices to VMs.
clipboard_length_limit_stc_enable	No	Boolean	Whether to limit the character length for clipboard redirection from VMs to local devices. Options: false: disabled true: enabled
clipboard_length_limit_stc	No	Integer	Whether to limit the character length for clipboard redirection from VMs to local devices.

**Table 36** Session
Parameter	Mandatory	Type	Description
sbc	No	Sbc object	SBC structure.

**Table 37** Sbc
Parameter	Mandatory	Type	Description
sbc_automatic_disconnection	No	String	Connection policy. DISABLED AUTO_DISCONNECT AUTO_LOCK: auto screen lock
sbc_automatic_disconnection_options	No	SbcAutomaticDisconnectionOptions object	Automatic connection options

**Table 38** SbcAutomaticDisconnectionOptions
Parameter	Mandatory	Type	Description
disconnection_waiting_time	No	Integer	Waiting time (minute)
sbc_auto_logout	No	Boolean	Indicates whether to enable automatic logout. Options: false: yes true: no
auto_logout_options	No	AutoLogoutOptions object	Automatic Logout

**Table 39** AutoLogoutOptions
Parameter	Mandatory	Type	Description
sbc_logout_waiting_time	No	Integer	Disconnection waiting time (minute)

**Table 40** VirtualChannel
Parameter	Mandatory	Type	Description
virtual_channel_control_enable	No	Boolean	Indicates whether to enable virtual channel policy control. Options: false: no; true: yes.
options	No	VirtualChannelOptions object	Virtual channel policy options.

**Table 41** VirtualChannelOptions
Parameter	Mandatory	Type	Description
custom_virtual_channel_name	No	String	Custom virtual channel name
virtual_channel_plugin_details	No	String	Virtual channel plug-in details (Base64)
third_party_plugin_name	No	String	Third-party plug-in name

**Table 42** keyboard_mouse
Parameter	Mandatory	Type	Description
mouse_feedback	No	String	VM mouse feedback. Options: SELFADAPTION: self-adaptive mouse feedback FORCE: forcible mouse feedback CLOSE mouse feedback disabled
mouse_simulation_mode	No	String	VM mouse simulation mode. Options: ABSOLUTE_POSITION: absolute position simulation RELATIVE_POSITION: relative position simulation
external_cursor_feedback	No	Boolean	Indicates whether to enable VM external cursor feedback. Options: false: no; true: yes.

**Table 43** Bandwidth
Parameter	Mandatory	Type	Description
intelligent_data_transport_flag	No	String	Indicates whether to enable Intelligent Display Transport (IDT). The value can be DISABLE, ENABLE, or DIAGNOSTIC (diagnosis mode).
total_bandwidth_control_enable	No	Boolean	Indicates whether to enable total bandwidth control. Options: false: no; true: yes.
options	No	TotalBandwidthControlOptions object	Total bandwidth options.
display_bandwidth_control_enable	No	Boolean	Indicates whether to enable display bandwidth control. Options: false: no; true: yes.
display_bandwidth_control_options	No	DisplayBandwidthControlOptions object	Display bandwidth options.
multimedia_bandwidth_control_enable	No	Boolean	Indicates whether to enable multimedia bandwidth control. Options: false: no; true: yes.
multimedia_bandwidth_control_options	No	MultimediaBandwidthControlOptions object	Multimedia bandwidth options.
usb_bandwidth_control_enable	No	Boolean	Indicates whether to enable USB bandwidth control. Options: false: no; true: yes.
usb_bandwidth_control_options	No	UsbBandwidthControlOptions object	USB bandwidth options.
pcsc_bandwidth_control_enable	No	Boolean	Indicates whether to enable PCSC control. Options: false: no; true: yes.
pcsc_bandwidth_control_options	No	PcscBandwidthControlOptions object	PCSC bandwidth options.
twain_bandwidth_control_enable	No	Boolean	Indicates whether to enable TWAIN bandwidth control. Options: false: no; true: yes.
twain_bandwidth_control_options	No	TwainBandwidthControlOptions object	TWAIN bandwidth options.
printer_bandwidth_control_enable	No	Boolean	Indicates whether to enable printer bandwidth control. Options: false: no; true: yes.
printer_bandwidth_control_options	No	PrinterBandwidthControlOptions object	Printer bandwidth options.
com_bandwidth_control_enable	No	Boolean	Indicates whether to enable serial port bandwidth control. Options: false: no; true: yes.
com_bandwidth_control_options	No	ComBandwidthControlOptions object	Serial port bandwidth options.
file_redirection_bandwidth_control_enable	No	Boolean	Indicates whether to enable file redirection bandwidth control. Options: false: no; true: yes.
file_redirection_bandwidth_control_options	No	FileRedirectionBandwidthControlOptions object	File redirection bandwidth options.
clipboard_bandwidth_control_enable	No	Boolean	Indicates whether to enable clipboard bandwidth control. Options: false: no; true: yes.
clipboard_bandwidth_control_options	No	ClipboardBandwidthControlOptions object	Clipboard bandwidth options.
secure_channel_bandwidth_control_enable	No	Boolean	Indicates whether to enable secure channel bandwidth control. Options: false: no; true: yes.
secure_channel_bandwidth_control_options	No	SecureChannelBandwidthControlOptions object	Secure channel bandwidth options.
camera_bandwidth_control_enable	No	Boolean	Indicates whether to enable camera bandwidth control. Options: false: no; true: yes.
camera_bandwidth_control_options	No	CameraBandwidthControlOptions object	Camera bandwidth options.
virtual_channel_bandwidth_control_enable	No	Boolean	Indicates whether to enable virtual channel bandwidth control. Options: false: no; true: yes.
virtual_channel_bandwidth_control_options	No	VirtualChannelBandwidthControlOptions object	Virtual channel bandwidth options.

**Table 44** TotalBandwidthControlOptions
Parameter	Mandatory	Type	Description
total_bandwidth_control_value	No	Integer	Total bandwidth control value (kbit/s). The value ranges from 10000 to 1000000. Default value: 30000
display_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable display bandwidth percentage control. Options: false: no; true: yes.
display_bandwidth_percentage_options	No	DisplayBandwidthPercentageOptions object	Display bandwidth percentage options.
multimedia_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable multimedia bandwidth percentage control. Options: false: no; true: yes.
multimedia_bandwidth_percentage_options	No	MultimediaBandwidthPercentageOptions object	Multimedia bandwidth percentage options.
usb_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable USB bandwidth percentage control. Options: false: no; true: yes.
usb_bandwidth_percentage_options	No	UsbBandwidthPercentageOptions object	USB bandwidth percentage options.
pcsc_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable PCSC bandwidth percentage control. Options: false: no; true: yes.
pcsc_bandwidth_percentage_options	No	PcscBandwidthPercentageOptions object	PCSC bandwidth percentage options.
twain_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable TWAIN bandwidth percentage control. Options: false: no; true: yes.
twain_bandwidth_percentage_options	No	TwainBandwidthPercentageOptions object	TWAIN bandwidth percentage options.
printer_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable printer bandwidth percentage control. Options: false: no; true: yes.
printer_bandwidth_percentage_options	No	PrinterBandwidthPercentageOptions object	Printer bandwidth percentage options.
com_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable serial port bandwidth percentage control. Options: false: no; true: yes.
com_bandwidth_percentage_options	No	ComBandwidthPercentageOptions object	Serial port bandwidth percentage options.
file_redirection_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable file redirection bandwidth percentage control. Options: false: no; true: yes.
file_redirection_bandwidth_percentage_options	No	FileRedirectionBandwidthPercentageOptions object	File redirection bandwidth percentage options.
clipboard_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable clipboard bandwidth percentage control. Options: false: no; true: yes.
clipboard_bandwidth_percentage_options	No	ClipboardBandwidthPercentageOptions object	Clipboard bandwidth percentage options.
secure_channel_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable secure channel bandwidth percentage control. Options: false: no; true: yes.
secure_channel_bandwidth_percentage_options	No	SecureChannelBandwidthPercentageOptions object	Secure channel bandwidth percentage options.
camera_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable camera bandwidth percentage control. Options: false: no; true: yes.
camera_bandwidth_percentage_options	No	CameraBandwidthPercentageOptions object	Camera bandwidth percentage options.
virtual_channel_bandwidth_percentage_enable	No	Boolean	Indicates whether to enable virtual channel bandwidth percentage control. Options: false: no; true: yes.
virtual_channel_bandwidth_percentage_options	No	VirtualChannelBandwidthPercentageOptions object	Virtual channel bandwidth percentage options.

**Table 45** DisplayBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
display_bandwidth_percentage_value	No	Integer	Display bandwidth control value (%). The value ranges from 0 to 100. Default value: 65

**Table 46** MultimediaBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
multimedia_bandwidth_percentage_value	No	Integer	Multimedia bandwidth control value (%). The value ranges from 0 to 100. Default value: 50

**Table 47** UsbBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
usb_bandwidth_percentage_value	No	Integer	USB bandwidth control value (%). The value ranges from 0 to 100. Default value: 100

**Table 48** PcscBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
pcsc_bandwidth_percentage_value	No	Integer	PCSC bandwidth control value (%). The value ranges from 0 to 100. Default value: 5

**Table 49** TwainBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
twain_bandwidth_percentage_value	No	Integer	TWAIN bandwidth control value (%). The value ranges from 0 to 100. Default value: 15

**Table 50** PrinterBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
printer_bandwidth_percentage_value	No	Integer	Printer bandwidth control value (%). The value ranges from 0 to 100. Default value: 5

**Table 51** ComBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
com_bandwidth_percentage_value	No	Integer	Serial port bandwidth control value (%). The value ranges from 0 to 100. Default value: 3

**Table 52** FileRedirectionBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
file_redirection_bandwidth_percentage_value	No	Integer	File redirection bandwidth control value (%). The value ranges from 0 to 100. Default value: 30

**Table 53** ClipboardBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
clipboard_bandwidth_percentage_value	No	Integer	Clipboard bandwidth control value (%). The value ranges from 0 to 100. Default value: 3

**Table 54** SecureChannelBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
secure_channel_bandwidth_percentage_value	No	Integer	Secure channel bandwidth control value (%). The value ranges from 0 to 100. Default value: 30

**Table 55** CameraBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
camera_bandwidth_percentage_value	No	Integer	Camera bandwidth control value (%). The value ranges from 0 to 100. Default value: 30

**Table 56** VirtualChannelBandwidthPercentageOptions
Parameter	Mandatory	Type	Description
virtual_channel_bandwidth_percentage_value	No	Integer	Virtual channel bandwidth control value (%). The value ranges from 0 to 100. Default value: 65

**Table 57** DisplayBandwidthControlOptions
Parameter	Mandatory	Type	Description
display_bandwidth_control_value	No	Integer	Display bandwidth control value (kbit/s). The value ranges from 500 to 50000. Default value: 20000

**Table 58** MultimediaBandwidthControlOptions
Parameter	Mandatory	Type	Description
multimedia_bandwidth_control_value	No	Integer	Multimedia bandwidth control value (kbit/s). The value ranges from 5000 to 20000. Default value: 15000

**Table 59** UsbBandwidthControlOptions
Parameter	Mandatory	Type	Description
usb_bandwidth_control_value	No	Integer	USB bandwidth control value (kbit/s). The value ranges from 1000 to 30000. Default value: 30000

**Table 60** PcscBandwidthControlOptions
Parameter	Mandatory	Type	Description
pcsc_bandwidth_control_value	No	Integer	PCSC bandwidth control value (kbit/s). The value ranges from 1000 to 5000. Default value: 2000

**Table 61** TwainBandwidthControlOptions
Parameter	Mandatory	Type	Description
twain_bandwidth_control_value	No	Integer	TWAIN bandwidth control value (kbit/s). The value ranges from 2000 to 10000. Default value: 5000

**Table 62** PrinterBandwidthControlOptions
Parameter	Mandatory	Type	Description
printer_bandwidth_control_value	No	Integer	Printer bandwidth control value (kbit/s). The value ranges from 1000 to 5000. Default value: 2000

**Table 63** ComBandwidthControlOptions
Parameter	Mandatory	Type	Description
com_bandwidth_control_value	No	Integer	Serial port bandwidth control value (kbit/s). The value ranges from 500 to 2000. Default value: 1000

**Table 64** FileRedirectionBandwidthControlOptions
Parameter	Mandatory	Type	Description
file_redirection_bandwidth_control_value	No	Integer	File redirection bandwidth control value (kbit/s). The value ranges from 500 to 20000. Default value: 10000

**Table 65** ClipboardBandwidthControlOptions
Parameter	Mandatory	Type	Description
clipboard_bandwidth_control_value	No	Integer	Clipboard bandwidth control value (kbit/s). The value ranges from 100 to 2000. Default value: 1000

**Table 66** SecureChannelBandwidthControlOptions
Parameter	Mandatory	Type	Description
secure_channel_bandwidth_control_value	No	Integer	Secure channel bandwidth control value (kbit/s). The value ranges from 500 to 20000. Default value: 10000

**Table 67** CameraBandwidthControlOptions
Parameter	Mandatory	Type	Description
camera_bandwidth_control_value	No	Integer	Camera bandwidth control value (kbit/s). The value ranges from 0 to 10000. Default value: 10000

**Table 68** VirtualChannelBandwidthControlOptions
Parameter	Mandatory	Type	Description
virtual_channel_bandwidth_control_value	No	Integer	Virtual channel bandwidth control value (kbit/s). The value ranges from 500 to 20000. Default value: 20000

**Table 69** custom
Parameter	Mandatory	Type	Description
custom_configuration1_enable	No	Boolean	Indicates whether to enable custom policy configuration item 1. Options: false: no true: yes
options	No	CustomOptions object	Custom policy options

**Table 70** CustomOptions
Parameter	Mandatory	Type	Description
custom_configuration1_rule	No	String	Configuration item 1
rail_transparent_config	No	RailTransparentConfig object	Application image policy settings.

**Table 71** RailTransparentConfig
Parameter	Mandatory	Type	Description
select_policy	No	Integer	Policy configuration principle.
transparent_list_custom	No	String	Configuration item.

**Table 72** cloud_storage
Parameter	Mandatory	Type	Description
cloud_storage_enable	No	Boolean	Whether to enable cloud storage: false: disabled true: enabled
options	No	CloudStorageOptions object	Cloud storage configuration.

**Table 73** CloudStorageOptions
Parameter	Mandatory	Type	Description
cloud_storage_rule	No	String	Configuration item.

**Table 74** user_profile
Parameter	Mandatory	Type	Description
user_profile_enable	No	Boolean	Whether to enable profile roaming. false: disabled true: enabled
options	No	UpmOptions object	Profile roaming.

**Table 75** UpmOptions
Parameter	Mandatory	Type	Description
user_profile_rule	No	String	Configuration item.
redir_exclude_common_folders	No	String	Excludes common folders.
redir_exclude_copy0s	No	String	Prohibits custom folders/copy base = 0, copy back = 0.
redir_exclude_copy1s	No	String	Prohibits custom folders/copy base = 0, copy back = 1.
redir_exclude_copy2s	No	String	Prohibits custom folders/copy base = 1, copy back = 0.
redir_exclude_copy3s	No	String	Prohibits custom folders/copy base = 1, copy back = 1.
redir_exclude_includes	No	String	Allows for customized folders.

**Table 76** url_redirection
Parameter	Mandatory	Type	Description
url_redirection_enable	No	Boolean	URL redirection status. false: disabled true: enabled
options	No	UrlRedirectionOptions object	URL redirection configuration.

**Table 77** UrlRedirectionOptions
Parameter	Mandatory	Type	Description
url_include_list	No	String	URLs that are allowed for redirection.
url_exclude_list	No	String	URLs that are rejected for redirection.

**Table 78** folder_redirection
Parameter	Mandatory	Type	Description
folder_redirection_status	No	Integer	Folder redirection status. 0: disabled 1: enabled 2: not configured
options	No	FolderRedirectionOptions object	Configuration of folder redirection.

**Table 79** FolderRedirectionOptions
Parameter	Mandatory	Type	Description
relative_path	No	String	Location of the target folder.
storage_paths	No	String	User storage path.
include_common_folders	No	Integer	Folder option.

**Table 80** folder_redirection_v2
Parameter	Mandatory	Type	Description
folder_redirection_v2_status	No	Integer	Folder redirection status. 0: disabled. 1: enabled.
options	No	FolderRedirectionV2Options object	Folder redirection configuration (v2).

**Table 81** FolderRedirectionV2Options
Parameter	Mandatory	Type	Description
app_data_roaming_configurations	No	AppDataRoamingConfigurations object	AppData (Roaming) folder redirection configuration.
desktop_configurations	No	DesktopConfigurations object	Desktop folder redirection configuration.
start_menu_configurations	No	StartMenuConfigurations object	Start menu folder redirection configuration.
documents_configurations	No	DocumentsConfigurations object	Documents folder redirection configuration.
pictures_configurations	No	PicturesConfigurations object	Pictures folder redirection configuration.
music_configurations	No	MusicConfigurations object	Music folder redirection configuration.
videos_configurations	No	VideosConfigurations object	Video folder redirection configuration.
favorites_configurations	No	FavoritesConfigurations object	Favorites folder redirection configuration.
contacts_configurations	No	ContactsConfigurations object	Contacts folder redirection configuration.
downloads_configurations	No	DownloadsConfigurations object	Downloads folder redirection configuration.
links_configurations	No	LinksConfigurations object	Link folder redirection configuration.
searches_configurations	No	SearchesConfigurations object	Search folder redirection configuration.
saved_games_configurations	No	SavedGamesConfigurations object	Saved games folder redirection configuration.

**Table 82** AppDataRoamingConfigurations
Parameter	Mandatory	Type	Description
app_data_roaming_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
app_data_roaming_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
app_data_roaming_storage_path	No	String	User storage path for folder redirection (v2).
app_data_roaming_relative_path	No	String	Location of the target folder.
app_data_roaming_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
app_data_roaming_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
app_data_roaming_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 83** DesktopConfigurations
Parameter	Mandatory	Type	Description
desktop_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
desktop_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
desktop_storage_path	No	String	User storage path for folder redirection (v2).
desktop_relative_path	No	String	Location of the target folder.
desktop_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
desktop_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
desktop_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 84** StartMenuConfigurations
Parameter	Mandatory	Type	Description
start_menu_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
start_menu_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
start_menu_storage_path	No	String	User storage path for folder redirection (v2).
start_menu_relative_path	No	String	Location of the target folder.
start_menu_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
start_menu_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
start_menu_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 85** DocumentsConfigurations
Parameter	Mandatory	Type	Description
documents_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
documents_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
documents_storage_path	No	String	User storage path for folder redirection (v2).
documents_relative_path	No	String	Location of the target folder.
documents_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
documents_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
documents_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 86** PicturesConfigurations
Parameter	Mandatory	Type	Description
pictures_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
pictures_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
pictures_storage_path	No	String	User storage path for folder redirection (v2).
pictures_relative_path	No	String	Location of the target folder.
pictures_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
pictures_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
pictures_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 87** MusicConfigurations
Parameter	Mandatory	Type	Description
music_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
music_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
music_storage_path	No	String	User storage path for folder redirection (v2).
music_relative_path	No	String	Location of the target folder.
music_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
music_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
music_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 88** VideosConfigurations
Parameter	Mandatory	Type	Description
videos_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
videos_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
videos_storage_path	No	String	User storage path for folder redirection (v2).
videos_relative_path	No	String	Location of the target folder.
videos_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
videos_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
videos_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 89** FavoritesConfigurations
Parameter	Mandatory	Type	Description
favorites_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
favorites_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
favorites_storage_path	No	String	User storage path for folder redirection (v2).
favorites_relative_path	No	String	Location of the target folder.
favorites_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
favorites_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
favorites_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 90** ContactsConfigurations
Parameter	Mandatory	Type	Description
contacts_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
contacts_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
contacts_storage_path	No	String	User storage path for folder redirection (v2).
contacts_relative_path	No	String	Location of the target folder.
contacts_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
contacts_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
contacts_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 91** DownloadsConfigurations
Parameter	Mandatory	Type	Description
downloads_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
downloads_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
downloads_storage_path	No	String	User storage path for folder redirection (v2).
downloads_relative_path	No	String	Location of the target folder.
downloads_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
downloads_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
downloads_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 92** LinksConfigurations
Parameter	Mandatory	Type	Description
links_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
links_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
links_storage_path	No	String	User storage path for folder redirection (v2).
links_relative_path	No	String	Location of the target folder.
links_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
links_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
links_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 93** SearchesConfigurations
Parameter	Mandatory	Type	Description
searches_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
searches_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
searches_storage_path	No	String	User storage path for folder redirection (v2).
searches_relative_path	No	String	Location of the target folder.
searches_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
searches_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
searches_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 94** SavedGamesConfigurations
Parameter	Mandatory	Type	Description
saved_games_status	No	Integer	Folder redirection status. 0: not selected. 1: selected.
saved_games_redirection_type	No	Integer	Folder redirection type. 0: remote. 1: local.
saved_games_storage_path	No	String	User storage path for folder redirection (v2).
saved_games_relative_path	No	String	Location of the target folder.
saved_games_exclusive_rights	No	Integer	Whether to enable the exclusive control permission of a user on the folder. 0: disabled. 1: enabled.
saved_games_move_contents	No	Integer	Whether to move the existing content to the new location when the folder redirection policy is enabled. 0: no. 1: yes.
saved_games_move_content_on_policy_removal	No	Integer	Whether to move the content back to the local user profile location when the policy is disabled or deleted. 0: no. 1: yes.

**Table 95** user_profile_management
Parameter	Mandatory	Type	Description
upm_status	No	Integer	User configuration status. 0: disabled 1: enabled 2: not configured
options	No	UserProfileManagementOptions object	User roaming configuration.

**Table 96** UserProfileManagementOptions
Parameter	Mandatory	Type	Description
profiles	No	UserProfileManagementProfiles object	Configuration of user roaming profile.

**Table 97** UserProfileManagementProfiles
Parameter	Mandatory	Type	Description
vhd_write_back	No	String	VHD session write-back status. 0: disabled 1: enabled 2: not configured

Response Parameters

Status code: 200

**Table 98** Response body parameters
Parameter	Type	Description
id	String	Primary key of the modified policy template

Status code: 400

**Table 99** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 100** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 101** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 102** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 103** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 104** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 105** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

patch /v1/29dfe82ada564ac2b927e1ff036d9a9b/policy-templates/1d23e82ada564ac2b927e1ff0361fe23

{
  "policy_group" : {
    "policy_group_name" : "aaa",
    "description" : "",
    "policies" : {
      "peripherals" : {
        "usb_port_redirection" : {
          "usb_enable" : true,
          "options" : {
            "usb_image_enable" : true,
            "usb_video_enable" : true,
            "usb_printer_enable" : true,
            "usb_storage_enable" : false,
            "wireless_devices_enable" : false,
            "network_devices_enable" : false,
            "usb_smart_card_enable" : true,
            "other_usb_devices_enable" : false,
            "usb_redirection_customization_policy" : "",
            "usb_redirection_mode" : "Classical mode"
          }
        },
        "device_redirection" : {
          "printer_redirection" : {
            "printer_enable" : true,
            "options" : {
              "sync_client_default_printer_enable" : true,
              "universal_printer_driver" : "Default"
            }
          },
          "session_printer" : {
            "session_printer_enable" : false,
            "options" : {
              "session_printer_customization_policy" : ""
            }
          },
          "camera_redirection" : {
            "video_compress_enable" : true,
            "options" : {
              "camera_frame_rate" : 15,
              "camera_max_width" : 3000,
              "camera_max_heigth" : 3000,
              "camera_compression_method" : "H.264"
            }
          },
          "twain_redirection_enable" : true,
          "image_compression_level" : "medium"
        },
        "usb_device_common" : {
          "pcsc_smart_card_enable" : "Disable",
          "common_options" : {
            "remove_smart_card_disconnect_enable" : false
          }
        },
        "serial_port_redirection" : {
          "serial_port_enable" : false,
          "options" : {
            "auto_connect_enable" : false
          }
        }
      },
      "audio" : {
        "audio_redirection_enable" : true,
        "play_redirection_enable" : true,
        "play_classification" : "Music Play",
        "record_redirection_enable" : true,
        "record_classification" : "Speech Call"
      },
      "client" : {
        "automatic_reconnection_interval" : 5,
        "session_persistence_time" : 180,
        "forbid_screen_capture" : false
      },
      "display" : {
        "display_level" : "LEVEL4",
        "options" : {
          "display_bandwidth" : 20000,
          "frame_rate" : 60,
          "video_frame_rate" : 60,
          "min_image_cache" : 200,
          "smoothing_factor" : 60,
          "lossless_compression_mode" : "Basic Compression",
          "deep_compression_options" : {
            "deep_compression_level" : "Compression grade 0"
          },
          "lossy_compression_quality" : 85,
          "color_enhancement_enable" : false,
          "quality_bandwidth_first" : "Bandwidth First",
          "video_bit_rate_options" : {
            "average_video_bit_rate" : 18000
          },
          "peak_video_bit_rate" : 18000,
          "video_quality_options" : {
            "average_video_quality" : 15,
            "lowest_video_quality" : 25,
            "highest_video_quality" : 7
          },
          "gop_size" : 100,
          "encoding_preset" : "Preset 1"
        },
        "rendering_acceleration_enable" : true,
        "rendering_acceleration_options" : {
          "video_acceleration_enhancement_enable" : true,
          "video_optimization_enable" : true,
          "gpu_color_optimization_enable" : true
        },
        "video_card_memory_size" : 64,
        "driver_delegation_mode_enable" : false,
        "driver_delegation_latency" : 80,
        "video_latency" : 80,
        "change_resolution_vm" : false
      },
      "file_and_clipboard" : {
        "bypass_in_remote_app_enable" : true,
        "file_redirection" : {
          "redirection_mode" : "DISABLED",
          "options" : {
            "fluid_control_switch_enable" : false,
            "fluid_control_options" : {
              "good_network_latency" : 30,
              "normal_network_latency" : 70,
              "poor_network_latency" : 100,
              "reducing_step" : 20,
              "slow_increasing_step" : 10,
              "quick_increasing_step" : 20,
              "start_speed" : 1024,
              "test_block_size" : 64,
              "test_time_gap" : 10000
            },
            "compression_switch_enable" : false,
            "compression_switch_options" : {
              "compression_threshold" : 512,
              "minimum_compression_rate" : 900
            },
            "linux_file_size_supported_enable" : true,
            "linux_file_size_supported_options" : {
              "linux_file_size_supported_threshold" : 100
            },
            "linux_root_mount_switch_enable" : true,
            "linux_root_dir_list" : "\\var\\log",
            "linux_file_mount_path" : "\\media|\\Volumes|\\swdb\\mnt|\\home|\\storage|\\tmp|\\run\\media",
            "linux_fixed_drive_file_system_format" : "",
            "linux_removable_drive_file_system_format" : "vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir",
            "linux_cdrom_drive_file_system_format" : "cd9660|iso9660|udf",
            "linux_network_drive_file_system_format" : "smbfs|afpfs|cifs",
            "path_separator" : "|",
            "fixed_drive_enable" : true,
            "removable_drive_enable" : true,
            "cd_rom_drive_enable" : true,
            "network_drive_enable" : true
          },
          "vm_send_file_client" : false,
          "redirection_send_file_options" : {
            "read_write_speed" : 0
          }
        },
        "fd_mobile_client_redir_enable" : true,
        "clipboard_redirection" : "DISABLED",
        "clipboard_redirection_options" : {
          "rich_text_redirection_enable" : true,
          "rich_text_clipboard_redirection" : "DISABLED",
          "clipboard_file_redirection_enable" : true,
          "file_clipboard_redirection" : "DISABLED",
          "clipboard_length_limit_cts_enable" : false,
          "clipboard_length_limit_cts" : 1,
          "clipboard_length_limit_stc_enable" : false,
          "clipboard_length_limit_stc" : 1
        }
      },
      "session" : {
        "sbc" : {
          "sbc_automatic_disconnection" : "AUTO_DISCONNECT",
          "sbc_automatic_disconnection_options" : {
            "disconnection_waiting_time" : 15,
            "sbc_auto_logout" : true,
            "auto_logout_options" : {
              "sbc_logout_waiting_time" : 60
            }
          }
        }
      },
      "virtual_channel" : {
        "virtual_channel_control_enable" : false,
        "options" : {
          "custom_virtual_channel_name" : "",
          "virtual_channel_plugin_details" : "",
          "third_party_plugin_name" : ""
        }
      },
      "keyboard_mouse" : {
        "mouse_feedback" : "SELFADAPTION",
        "mouse_simulation_mode" : "ABSOLUTE_POSITION",
        "external_cursor_feedback" : false
      },
      "bandwidth" : {
        "intelligent_data_transport_flag" : "DISABLE",
        "total_bandwidth_control_enable" : false,
        "options" : {
          "total_bandwidth_control_value" : 30000,
          "display_bandwidth_percentage_enable" : false,
          "display_bandwidth_percentage_options" : {
            "display_bandwidth_percentage_value" : 65
          },
          "multimedia_bandwidth_percentage_enable" : false,
          "multimedia_bandwidth_percentage_options" : {
            "multimedia_bandwidth_percentage_value" : 50
          },
          "usb_bandwidth_percentage_enable" : false,
          "usb_bandwidth_percentage_options" : {
            "usb_bandwidth_percentage_value" : 100
          },
          "pcsc_bandwidth_percentage_enable" : false,
          "pcsc_bandwidth_percentage_options" : {
            "pcsc_bandwidth_percentage_value" : 5
          },
          "twain_bandwidth_percentage_enable" : false,
          "twain_bandwidth_percentage_options" : {
            "twain_bandwidth_percentage_value" : 15
          },
          "printer_bandwidth_percentage_enable" : false,
          "printer_bandwidth_percentage_options" : {
            "printer_bandwidth_percentage_value" : 5
          },
          "com_bandwidth_percentage_enable" : false,
          "com_bandwidth_percentage_options" : {
            "com_bandwidth_percentage_value" : 3
          },
          "file_redirection_bandwidth_percentage_enable" : false,
          "file_redirection_bandwidth_percentage_options" : {
            "file_redirection_bandwidth_percentage_value" : 30
          },
          "clipboard_bandwidth_percentage_enable" : false,
          "clipboard_bandwidth_percentage_options" : {
            "clipboard_bandwidth_percentage_value" : 3
          },
          "secure_channel_bandwidth_percentage_enable" : false,
          "secure_channel_bandwidth_percentage_options" : {
            "secure_channel_bandwidth_percentage_value" : 30
          },
          "camera_bandwidth_percentage_enable" : false,
          "camera_bandwidth_percentage_options" : {
            "camera_bandwidth_percentage_value" : 30
          },
          "virtual_channel_bandwidth_percentage_enable" : false,
          "virtual_channel_bandwidth_percentage_options" : {
            "virtual_channel_bandwidth_percentage_value" : 65
          }
        },
        "display_bandwidth_control_enable" : false,
        "display_bandwidth_control_options" : {
          "display_bandwidth_control_value" : 20000
        },
        "multimedia_bandwidth_control_enable" : false,
        "multimedia_bandwidth_control_options" : {
          "multimedia_bandwidth_control_value" : 15000
        },
        "usb_bandwidth_control_enable" : false,
        "usb_bandwidth_control_options" : {
          "usb_bandwidth_control_value" : 30000
        },
        "pcsc_bandwidth_control_enable" : false,
        "pcsc_bandwidth_control_options" : {
          "pcsc_bandwidth_control_value" : 2000
        },
        "twain_bandwidth_control_enable" : false,
        "twain_bandwidth_control_options" : {
          "twain_bandwidth_control_value" : 5000
        },
        "printer_bandwidth_control_enable" : false,
        "printer_bandwidth_control_options" : {
          "printer_bandwidth_control_value" : 2000
        },
        "com_bandwidth_control_enable" : false,
        "com_bandwidth_control_options" : {
          "com_bandwidth_control_value" : 1000
        },
        "file_redirection_bandwidth_control_enable" : false,
        "file_redirection_bandwidth_control_options" : {
          "file_redirection_bandwidth_control_value" : 10000
        },
        "clipboard_bandwidth_control_enable" : false,
        "clipboard_bandwidth_control_options" : {
          "clipboard_bandwidth_control_value" : 1000
        },
        "secure_channel_bandwidth_control_enable" : false,
        "secure_channel_bandwidth_control_options" : {
          "secure_channel_bandwidth_control_value" : 10000
        },
        "camera_bandwidth_control_enable" : false,
        "camera_bandwidth_control_options" : {
          "camera_bandwidth_control_value" : 10000
        },
        "virtual_channel_bandwidth_control_enable" : false,
        "virtual_channel_bandwidth_control_options" : {
          "virtual_channel_bandwidth_control_value" : 20000
        }
      },
      "custom" : {
        "custom_configuration1_enable" : true,
        "options" : {
          "custom_configuration1_rule" : "",
          "rail_transparent_config" : {
            "select_policy" : 0,
            "transparent_list_custom" : ""
          }
        }
      },
      "cloud_storage" : {
        "cloud_storage_enable" : true,
        "options" : {
          "cloud_storage_rule" : "{\"personal_folder\":{\"storage_paths\":[{\"storage_type\":\"HUAWEI_CLOUD_SFS\",\"project_config_id\":\"\"}]},\"shared_folder\":{}}"
        }
      },
      "user_profile" : {
        "user_profile_enable" : true,
        "options" : {
          "user_profile_rule" : "{\"ProfileEnable\":{\"status\":1,\"value\":0},\"ProfileLocations\":{\"status\":1,\"type\":\"SMBLocation\",\"user_profile_locations\":[{\"id\":0,\"container_type\":\"HUAWEI_CLOUD_SFS\",\"path\":\"\"}]},\"ProfileVhdType\":{\"status\":1,\"value\":\"vhdx\"},\"ProfileIsDynamic\":{\"status\":1,\"value\":1},\"ProfileVhdFileSize\":{\"status\":1,\"value\":30000},\"ProfileDiffDiskParentFolderPath\":{\"status\":2,\"value\":\"%TEMP%\"},\"ProfileSidDirNameRule\":{\"status\":2,\"value\":\"%sid%_%username%\"},\"ProfileSidDirMatchRule\":{\"status\":2,\"value\":\"%sid%_%username%\"},\"ProfileVhdFileNameRule\":{\"status\":2,\"value\":\"Profile_%username%\"},\"ProfileVhdFileMatchRule\":{\"status\":2,\"value\":\"Profile*\"},\"ProfileNoProfileContainingFolder\":{\"status\":2,\"value\":0},\"ProfileFlipFlopProfileDirectoryName\":{\"status\":2,\"value\":0},\"ProfileRemoveOrphanedOSTFilesOnLogoff\":{\"status\":2,\"value\":0},\"ProfileVolumeWaitTimeMS\":{\"status\":2,\"value\":20000},\"ProfileVHDXSectorSize\":{\"status\":2,\"value\":0},\"ProfileRebootOnUserLogoff\":{\"status\":2,\"value\":0},\"ProfileRedirectType\":{\"status\":2,\"value\":2},\"ProfileSetTempToLocalPath\":{\"status\":2,\"value\":3},\"ProfileRoamSearch\":{\"status\":2,\"value\":0},\"ProfileLockedRetryInterval\":{\"status\":2,\"value\":5},\"ProfileVhdAttachedRetryTimes\":{\"status\":2,\"value\":60},\"ProfileShutdownOnUserLogoff\":{\"status\":2,\"value\":0},\"ProfileOutlookCachedMode\":{\"status\":2,\"value\":1},\"ProfileKeepLocalDir\":{\"status\":2,\"value\":0},\"ProfilePreventLoginWithFailure\":{\"status\":2,\"value\":0},\"ProfileDirSDDL\":{\"status\":2,\"value\":\"N/A\"},\"ProfileRedirXmlLocation\":{\"status\":2,\"value\":\"N/A\"},\"ProfileAttachVHDSDDL\":{\"status\":2,\"value\":\"N/A\"},\"ProfileDeleteLocalProfile\":{\"status\":2,\"value\":0},\"ProfileInstallAppxPackages\":{\"status\":2,\"value\":1},\"ProfilePreventLoginWithTempProfile\":{\"status\":2,\"value\":0},\"ProfileVhdReattachInterval\":{\"status\":2,\"value\":10},\"SIDDirSDDL\":{\"status\":2,\"value\":\"N/A\"},\"ProfileCleanOutNotifications\":{\"status\":2,\"value\":1},\"ProfileRoamIdentity\":{\"status\":2,\"value\":0},\"ProfileAccessNetworkAsComputerObject\":{\"status\":2,\"value\":0},\"ProfileType\":{\"status\":2,\"value\":0},\"ProfileLockedRetryCount\":{\"status\":2,\"value\":12},\"ODFCEnable\":{\"status\":1,\"value\":0},\"ODFCLocations\":{\"status\":1,\"type\":\"SMBLocation\",\"user_profile_locations\":[{\"id\":0,\"container_type\":\"HUAWEI_CLOUD_SFS\",\"path\":\"\"}]},\"ODFCVHDType\":{\"status\":1,\"value\":\"vhdx\"},\"ODFCIsDynamic\":{\"status\":1,\"value\":1},\"ODFCVHDFileSize\":{\"status\":1,\"value\":30000},\"ODFCVHDNamePattern\":{\"status\":2,\"value\":\"ODFC_%username%\"},\"ODFCSIDDirNamePattern\":{\"status\":2,\"value\":\"%sid%_%username%\"},\"ODFCSIDDirNameMatch\":{\"status\":2,\"value\":\"%sid%_%username%\"},\"ODFCDiffDiskParentFolderPath\":{\"status\":2,\"value\":\"%TEMP%\"},\"ODFCFlipFlopProfileDirectoryName\":{\"status\":2,\"value\":0},\"ODFCVHDNameMatch\":{\"status\":2,\"value\":\"ODFC*\"},\"ODFCNoProfileContainingFolder\":{\"status\":2,\"value\":0},\"IncludeOfficeActivation\":{\"status\":2,\"value\":1},\"IncludeOneNote\":{\"status\":2,\"value\":0},\"ODFCVHDXSectorSize\":{\"status\":2,\"value\":0},\"OutlookFolderPath\":{\"status\":2,\"value\":\"%userprofile%\\\\AppData\\\\Local\\\\Microsoft\\\\Outlook\"},\"ODFCVolumeWaitTimeMS\":{\"status\":2,\"value\":20000},\"IncludeOutlookPersonalization\":{\"status\":2,\"value\":1},\"ODFCVHDReAttachIntervalSeconds\":{\"status\":2,\"value\":10},\"ODFCMirrorLocalOSTToVHD\":{\"status\":2,\"value\":0},\"ODFCIncludeTeams\":{\"status\":2,\"value\":0},\"ODFCRemoveOrphanedOSTFilesOnLogoff\":{\"status\":2,\"value\":0},\"ODFCVHDReAttachRetryCount\":{\"status\":2,\"value\":60},\"ODFCLockedRetryInterval\":{\"status\":2,\"value\":5},\"ODFCIncludeOneNote_UWP\":{\"status\":2,\"value\":0},\"ODFCRedirectType\":{\"status\":2,\"value\":2},\"ODFCLockedRetryCount\":{\"status\":2,\"value\":12},\"IncludeOneDrive\":{\"status\":2,\"value\":1},\"ODFCRefreshUserPolicy\":{\"status\":2,\"value\":0},\"IncludeSkype\":{\"status\":2,\"value\":1},\"ODFCRoamSearch\":{\"status\":2,\"value\":0},\"OutlookCachedMode\":{\"status\":2,\"value\":1},\"ODFCIncludeSharepoint\":{\"status\":2,\"value\":1},\"IncludeOutlook\":{\"status\":2,\"value\":1},\"ODFCAttachVHDSDDL\":{\"status\":2,\"value\":\"N/A\"},\"ODFCAccessNetworkAsComputerObject\":{\"status\":2,\"value\":0},\"ODFCPreventLoginWithTempProfile\":{\"status\":2,\"value\":0},\"ODFCPreventLoginWithFailure\":{\"status\":2,\"value\":0},\"ODFCNumSessionVHDsToKeep\":{\"status\":2,\"value\":2},\"ODFCVHDAccessMode\":{\"status\":2,\"value\":0},\"CacheEnable\":{\"status\":1,\"value\":0},\"CacheDirectory\":{\"status\":2,\"value\":\"C:\\\\ProgramData\\\\FSLogix\\\\Cache\"},\"WriteCacheDirectory\":{\"status\":2,\"value\":\"C:\\\\ProgramData\\\\FSLogix\\\\Cache\"},\"ProxyDirectory\":{\"status\":2,\"value\":\"C:\\\\ProgramData\\\\FSLogix\\\\Proxy\"},\"ProfileCcdUnregisterTimeout\":{\"status\":2,\"value\":0},\"ProfileHealthyProvidersRequiredForRegister\":{\"status\":2,\"value\":0},\"ProfileHealthyProvidersRequiredForUnregister\":{\"status\":2,\"value\":1},\"ProfileClearCacheOnLogoff\":{\"status\":2,\"value\":0},\"ProfileClearCacheOnForcedUnregister\":{\"status\":2,\"value\":0},\"ODFCClearCacheOnForcedUnregister\":{\"status\":2,\"value\":0},\"ODFCClearCacheOnLogoff\":{\"status\":2,\"value\":0},\"ODFCHealthyProvidersRequiredForRegister\":{\"status\":2,\"value\":0},\"ODFCHealthyProvidersRequiredForUnregister\":{\"status\":2,\"value\":1},\"ODFCCcdUnregisterTimeout\":{\"status\":2,\"value\":0},\"LoggingEnabled\":{\"status\":1,\"value\":2},\"LogLevel\":{\"status\":1,\"value\":1},\"LogFileKeepingPeriod\":{\"status\":1,\"value\":7},\"LogLocation\":{\"status\":1,\"value\":\"%ProgramData%\\\\FSLogix\\\\Logs\"},\"RobocopyLogPath\":{\"status\":1,\"value\":\"\"},\"DriverInterface\":{\"status\":1,\"value\":0},\"RuleCompilation\":{\"status\":1,\"value\":0},\"ProcessStart\":{\"status\":1,\"value\":0},\"LoggingProfile\":{\"status\":1,\"value\":1},\"LoggingService\":{\"status\":1,\"value\":0},\"LoggingPrinter\":{\"status\":1,\"value\":0},\"LoggingFont\":{\"status\":1,\"value\":0},\"ConfigTool\":{\"status\":1,\"value\":1},\"LoggingODFC\":{\"status\":1,\"value\":0},\"AdsComputerGroup\":{\"status\":1,\"value\":0},\"LoggingNetwork\":{\"status\":1,\"value\":0},\"LoggingSearch\":{\"status\":1,\"value\":1},\"FrxLauncher\":{\"status\":1,\"value\":0},\"SearchPlugin\":{\"status\":1,\"value\":0}}",
          "redir_exclude_common_folders" : "{\"status\":1,\"value\":0}",
          "redir_exclude_copy0s" : "[]",
          "redir_exclude_copy1s" : "[]",
          "redir_exclude_copy2s" : "[]",
          "redir_exclude_copy3s" : "[]",
          "redir_exclude_includes" : "[]"
        }
      },
      "url_redirection" : {
        "url_redirection_enable" : false,
        "options" : {
          "url_exclude_list" : "[]",
          "url_include_list" : "[{\"id\":\"testf682f5fb43etestf9ea68d4e026a\",\"status\":1,\"value\":\"http://*\"},{\"id\":\"testf682f5fb43etestcd9c2d3bc14ac14\",\"status\":1,\"value\":\"https://*\"}]"
        }
      },
      "folder_redirection" : {
        "folder_redirection_status" : 2,
        "options" : {
          "relative_path" : "",
          "storage_paths" : "{\"storage_type\":\"HUAWEI_CLOUD_SFS\",\"project_config_id\":\"\"}",
          "include_common_folders" : 0
        }
      },
      "user_profile_management" : {
        "upm_status" : 1,
        "options" : {
          "profiles" : {
            "vhd_write_back" : "{\"status\":2,\"value\":0}"
          }
        }
      }
    }
  }
}

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : "2c9080c97f310b73017f3f9501070043"
}

Status Codes

Status Code	Description
200	Response to a successful request.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	Permissions required.
404	No resources found.
405	The request method is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.

Error Codes

See Error Codes.

Parent topic: Policy Management

Previous topic: Querying Policy Templates

Next topic: Deleting a Policy Template

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot