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

Querying Initial Policy Items

Function

Queries initial policy items. An initial policy item is the default configuration of all protocol configuration items. Users can modify the initial policy item as required to create a new policy group.

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, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/policy-groups/actions/list-original-policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project 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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

policies

Policies object

Policy class

Table 4 Policies

Parameter

Type

Description

peripherals

peripherals object

Peripherals

audio

audio object

Audio

client

client object

Client

display

display object

Display

file_and_clipboard

file_and_clipboard object

File & Clipboard

session

Session object

Session

virtual_channel

VirtualChannel object

Virtual channel

keyboard_mouse

keyboard_mouse object

Keyboard & Mouse

bandwidth

Bandwidth object

Bandwidth

custom

custom object

Custom policy

cloud_storage

cloud_storage object

Cloud storage configuration.

user_profile

user_profile object

Profile roaming.

url_redirection

url_redirection object

Configures URL redirection.

folder_redirection

folder_redirection object

Configures folder redirection.

folder_redirection_v2

folder_redirection_v2 object

Folder redirection (v2) configuration.

user_profile_management

user_profile_management object

User configuration policy.

Table 5 peripherals

Parameter

Type

Description

usb_port_redirection

usb_port_redirection object

USB port redirection.

device_redirection

device_redirection object

Device redirection.

usb_device_common

usb_device_common object

USB and device smartcard options.

serial_port_redirection

serial_port_redirection object

Serial port redirection

Table 6 usb_port_redirection

Parameter

Type

Description

usb_enable

Boolean

Indicates whether to enable USB port redirection. Options:

  • false: no

true: yes

options

UsbPortRedirectionOptions object

USB port redirection options.

Table 7 UsbPortRedirectionOptions

Parameter

Type

Description

usb_image_enable

Boolean

Indicates whether to enable image devices, such as a scanner. Options:

  • false: no;

  • true: yes.

usb_video_enable

Boolean

Indicates whether to enable video devices, such as cameras. Options:

  • false: no;

  • true: yes.

usb_printer_enable

Boolean

Indicates whether to enable print devices, such as a printer. Options:

  • false: no;

  • true: yes.

usb_storage_enable

Boolean

Indicates whether to enable storage devices, such as USB flash drives. Options:

  • false: no;

  • true: yes.

wireless_devices_enable

Boolean

Indicates whether to enable wireless connections, such as Bluetooth. Options:

  • false: no;

  • true: yes.

network_devices_enable

Boolean

Indicates whether to enable network devices, such as a wireless NIC. Options:

  • false: no;

  • true: yes.

usb_smart_card_enable

Boolean

Indicates whether to enable smartcard devices, such as USB keys. Options:

  • false: no;

  • true: yes.

other_usb_devices_enable

Boolean

Indicates whether to enable the redirection of other USB devices. Options:

  • false: no;

  • true: yes.

usb_redirection_customization_policy

String

Customized USB port redirection policy

usb_redirection_mode

String

USB redirection mode. Options:

  • Classical mode

  • Common mode

Table 8 device_redirection

Parameter

Type

Description

printer_redirection

printer_redirection object

Printer redirection

session_printer

session_printer object

Session printer

camera_redirection

camera_redirection object

Camera redirection.

twain_redirection_enable

Boolean

Indicates whether to enable TWAIN device redirection. Options:

false: no;

true: yes.

image_compression_level

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 9 printer_redirection

Parameter

Type

Description

printer_enable

Boolean

Specifies whether to enable printer redirection. Options:

  • false: no;

true: yes;

options

PrinterRedirectionOptions object

Printer redirection options.

Table 10 PrinterRedirectionOptions

Parameter

Type

Description

sync_client_default_printer_enable

Boolean

Specifies whether to enable the synchronization of the default client printer. Options:

false: no;

true: yes.

universal_printer_driver

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 11 session_printer

Parameter

Type

Description

session_printer_enable

Boolean

Indicates whether to enable session printer. Options:

false: no;

true: yes.

options

SessionPrinterOptions object

Session printer options

Table 12 SessionPrinterOptions

Parameter

Type

Description

session_printer_customization_policy

String

Session printer custom policy

Table 13 camera_redirection

Parameter

Type

Description

video_compress_enable

Boolean

Indicates whether to enable camera redirection. Options:

false: no;

true: yes.

options

CameraRedirectionOptions object

Camera redirection options.

Table 14 CameraRedirectionOptions

Parameter

Type

Description

camera_frame_rate

Integer

Camera frame rate (FPS). The value ranges from 1 to 30. Default value: 15

camera_max_width

Integer

Camera maximum width (pixel). The value ranges from 1 to 9999. Default value: 3000

camera_max_heigth

Integer

Camera maximum height (pixel). The value ranges from 1 to 9999. Default value: 3000

camera_compression_method

String

Camera data compression method. The value is H.264.

Table 15 usb_device_common

Parameter

Type

Description

pcsc_smart_card_enable

String

Indicates whether to enable PC/SC smartcard redirection. Options:

Enable

Closed

Disable

common_options

common_options object

Options for both USB and device smartcard.

Table 16 common_options

Parameter

Type

Description

remove_smart_card_disconnect_enable

Boolean

Indicates whether to enable smartcard removal to log out of user sessions. Options:

false: no;

true: yes.

Table 17 serial_port_redirection

Parameter

Type

Description

serial_port_enable

Boolean

Specifies whether to enable serial port redirection. Options:

false: no;

true: yes.

options

SerialPortRedirectionOptions object

Serial port redirection options.

Table 18 SerialPortRedirectionOptions

Parameter

Type

Description

auto_connect_enable

Boolean

Indicates whether to enable automatic connection to client serial ports. Options:

false: no;

true: yes.

Table 19 audio

Parameter

Type

Description

audio_redirection_enable

Boolean

Indicates whether to enable audio redirection. Options:

false: no;

true: yes.

play_redirection_enable

Boolean

Indicates whether to enable playback redirection. Options:

false: no;

true: yes.

play_classification

String

Play scenarios. Options:

Lossless

Speech Call

Music Play

Automatic Identification

record_redirection_enable

Boolean

Indicates whether to enable recording redirection. Options:

false: no;

true: yes.

record_classification

String

Recording scenarios. Options:

Lossless

Speech Call

Music Record

Automatic Identification

Table 20 client

Parameter

Type

Description

automatic_reconnection_interval

Integer

Automatic reconnection interval (s). The value ranges from 1 to 50. Default value: 5

session_persistence_time

Integer

Session persistence time (s). The value ranges from 0 to 180. Default value: 180

forbid_screen_capture

Boolean

Indicates whether to enable the screen capture prevention policy. Options:

false: no

true: yes

Table 21 display

Parameter

Type

Description

display_level

String

Specifies the display level. Options:

LEVEL 1

LEVEL 2

LEVEL 3

LEVEL 4 (default/recommended)

LEVEL 5

options

DisplayOptions object

Display level options.

rendering_acceleration_enable

Boolean

Indicates whether to enable rendering acceleration. Options:

false: no;

true: yes.

rendering_acceleration_options

rendering_acceleration_options object

Rendering acceleration options.

video_card_memory_size

Integer

GPU card cache (MB). The value ranges from 0 to 64. Default value: 64

driver_delegation_mode_enable

Boolean

Indicates whether to enable the driver hosting mode. Options:

false: no;

true: yes.

driver_delegation_latency

Integer

Driver delegation delay (*30 ms). The value ranges from 1 to 100. Default value: 80

video_latency

Integer

Video Latency (*30 ms). The value ranges from 1 to 100. Default value: 80

change_resolution_vm

Boolean

Indicates whether to enable computer resolution change. Options:

false: no

true: yes

Table 22 DisplayOptions

Parameter

Type

Description

display_bandwidth

Integer

Bandwidth (kbit/s). The value ranges from 256 to 25000. Default value: 20000

frame_rate

Integer

Frame rate (FPS). The value ranges from 1 to 60. Default value: 25

video_frame_rate

Integer

Video frame rate (FPS). The value ranges from 1 to 60. Default value: 30

min_image_cache

Integer

Minimum capacity for image cache (MB). The value ranges from 0 to 300. Default value: 200

smoothing_factor

Integer

Lossy compression recognition threshold. The value ranges from 0 to 255. Default value: 60

lossless_compression_mode

String

Lossless compression mode. Options:

Basic Compression

Deep Compression

deep_compression_options

deep_compression_options object

Deep compression options.

lossy_compression_quality

Integer

Lossy compression quality. The value ranges from 20 to 100. Default value: 85

color_enhancement_enable

Boolean

Indicates whether to enable color enhancement in office scenarios. Options:

false: no

true: yes

quality_bandwidth_first

String

Quality/Bandwidth first. Options:

Quality First: indicates basic compression.

Bandwidth First: indicates deep compression.

video_bit_rate_options

video_bit_rate_options object

Video bitrate options.

peak_video_bit_rate

Integer

Peak video bitrate (kbit/s). The value ranges from 256 to 100000. Default value: 18000

video_quality_options

video_quality_options object

Video quality options.

gop_size

Integer

GOP size. The value ranges from 0 to 65535. Default value: 100

encoding_preset

String

Encoding preset. Options:

Preset 1

Preset 2

Preset 3

Preset 4

Preset 5

Preset 6

Preset 7

Table 23 deep_compression_options

Parameter

Type

Description

deep_compression_level

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 24 video_bit_rate_options

Parameter

Type

Description

average_video_bit_rate

Integer

Average video bitrate (kbit/s). The value ranges from 256 to 100000. Default value: 18000

Table 25 video_quality_options

Parameter

Type

Description

average_video_quality

Integer

Average video quality. The value ranges from 5 to 59. Default value: 15

lowest_video_quality

Integer

Lowest video quality. The value ranges from 5 to 69. Default value: 25

highest_video_quality

Integer

Highest video quality. The value ranges from 1 to 59. Default value: 7

Table 26 rendering_acceleration_options

Parameter

Type

Description

video_acceleration_enhancement_enable

Boolean

Indicates whether to enable video acceleration enhancement configuration. Options:

false: no;

true: yes.

video_optimization_enable

Boolean

Indicates whether to enable video scenario optimization. Options:

false: no;

true: yes.

gpu_color_optimization_enable

Boolean

Indicates whether to enable GPU color optimization. Options:

false: no;

true: yes.

Table 27 file_and_clipboard

Parameter

Type

Description

bypass_in_remote_app_enable

Boolean

Indicates whether to enable two-way bypass in the application aggregation scenario. Options:

false: no

true: yes

file_redirection

file_redirection object

File redirection

fd_mobile_client_redir_enable

Boolean

Specifies whether to enable mobile client file redirection. Options:

false: no

true: yes

clipboard_redirection

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

clipboard_redirection_options object

Clipboard redirection options.

Table 28 file_redirection

Parameter

Type

Description

redirection_mode

String

File redirection. Options:

DISABLED (default)

READ_ONLY

READ_AND_WRITE: indicates that files are readable and writable.

options

FileRedirectionOptions object

File redirection options.

vm_send_file_client

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

redirection_send_file_options object

Options for both redirection and file sending.

Table 29 FileRedirectionOptions

Parameter

Type

Description

fluid_control_switch_enable

Boolean

Indicates whether to enable the rate limit function. Options:

false: no;

true: yes.

fluid_control_options

fluid_control_options object

Rate limit options.

compression_switch_enable

Boolean

Indicates whether to enable the compression function. Options:

false: no;

true: yes.

compression_switch_options

compression_switch_options object

Compression switch options.

linux_file_size_supported_enable

Boolean

Indicates whether to enable the function of setting the file size in Linux. Options:

false: no;

true: yes.

linux_file_size_supported_options

linux_file_size_supported_options object

Options for setting the file size in Linux.

linux_root_mount_switch_enable

Boolean

Indicates whether to enable root directory mount in Linux. Options:

false: no;

true: yes.

linux_root_dir_list

String

Mount path of the Linux root directory. Default value: \home

linux_file_mount_path

String

Linux file system mount path. Default value: \media|\Volumes|\swdb\mnt|\home|\storage|\tmp|\run\media

linux_fixed_drive_file_system_format

String

Linux fixed driver file system format.

linux_removable_drive_file_system_format

String

Linux removable driver file system format. Default value: vfat|ntfs|msdos|fuseblk|sdcardfs|exfat|fuse.fdredir

linux_cdrom_drive_file_system_format

String

Linux CD-ROM driver file system format. Default value: cd9660|iso9660|udf

linux_network_drive_file_system_format

String

Linux network driver file system format. Default value: smbfs|afpfs|cifs

path_separator

String

Path separator. Default value: |

fixed_drive_enable

Boolean

Indicates whether to enable fixed drives (such as local disks). Options:

false: no;

true: yes.

removable_drive_enable

Boolean

Specifies whether to enable removable drives (such as USB flash drives). Options:

false: no;

true: yes.

cd_rom_drive_enable

Boolean

Indicates whether to enable the CD-ROM driver. Options:

false: no;

true: yes.

network_drive_enable

Boolean

Indicates whether to enable the network driver. Options:

false: no;

true: yes.

Table 30 fluid_control_options

Parameter

Type

Description

good_network_latency

Integer

Good network latency threshold (ms). The value ranges from 1 to 1000. Default value: 30

normal_network_latency

Integer

Normal network latency threshold (ms). The value ranges from 1 to 1000. Default value: 70

poor_network_latency

Integer

Poor network latency threshold (ms). The value ranges from 1 to 1000. Default value: 100

reducing_step

Integer

Reducing step (KB). The value ranges from 1 to 100. Default value: 20

slow_increasing_step

Integer

Slow increasing step (KB). The value ranges from 1 to 100. Default value: 10

quick_increasing_step

Integer

Quick increasing step (KB). The value ranges from 1 to 100. Default value: 20

start_speed

Integer

Start speed (KB/s). The value ranges from 1 to 10240. Default value: 1024

test_block_size

Integer

Test block size (KB). The value ranges from 64 to 1024. Default value: 64

test_time_gap

Integer

Test time gap (ms). The value ranges from 1000 to 100000. Default value: 10000

Table 31 compression_switch_options

Parameter

Type

Description

compression_threshold

Integer

Compression threshold (byte). The value ranges from 0 to 10240. Default value: 512

minimum_compression_rate

Integer

Minimum compression rate. The value ranges from 0 to 1000. Default value: 900

Table 32 linux_file_size_supported_options

Parameter

Type

Description

linux_file_size_supported_threshold

Integer

File size threshold supported by Linux (Byte). The value ranges from 0 to 4096. Default value: 100

Table 33 redirection_send_file_options

Parameter

Type

Description

read_write_speed

Integer

Read write speed (kbit/s). The value ranges from 0 to 2147483647. Default value: 0

Table 34 clipboard_redirection_options

Parameter

Type

Description

rich_text_redirection_enable

Boolean

Indicates whether to enable clipboard rich text redirection. Options:

false: no;

true: yes.

rich_text_clipboard_redirection

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

Boolean

Specifies whether to enable clipboard file redirection. Options:

false: no;

true: yes.

file_clipboard_redirection

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

Boolean

Whether to limit the character length for clipboard redirection from local devices to VMs. Options:

false: no

true: yes

clipboard_length_limit_cts

Integer

Maximum number of characters for clipboard redirection from local devices to VMs.

clipboard_length_limit_stc_enable

Boolean

Whether to limit the character length for clipboard redirection from VMs to local devices. Options:

false: disabled

true: enabled

clipboard_length_limit_stc

Integer

Whether to limit the character length for clipboard redirection from VMs to local devices.

Table 35 Session

Parameter

Type

Description

sbc

Sbc object

SBC structure.

Table 36 Sbc

Parameter

Type

Description

sbc_automatic_disconnection

String

Connection policy.

  • DISABLED

  • AUTO_DISCONNECT

  • AUTO_LOCK: auto screen lock

sbc_automatic_disconnection_options

SbcAutomaticDisconnectionOptions object

Automatic connection options

Table 37 SbcAutomaticDisconnectionOptions

Parameter

Type

Description

disconnection_waiting_time

Integer

Waiting time (minute)

sbc_auto_logout

Boolean

Indicates whether to enable automatic logout. Options: false: yes true: no

auto_logout_options

AutoLogoutOptions object

Automatic Logout

Table 38 AutoLogoutOptions

Parameter

Type

Description

sbc_logout_waiting_time

Integer

Disconnection waiting time (minute)

Table 39 VirtualChannel

Parameter

Type

Description

virtual_channel_control_enable

Boolean

Indicates whether to enable virtual channel policy control. Options: false: no; true: yes.

options

VirtualChannelOptions object

Virtual channel policy options.

Table 40 VirtualChannelOptions

Parameter

Type

Description

custom_virtual_channel_name

String

Custom virtual channel name

virtual_channel_plugin_details

String

Virtual channel plug-in details (Base64)

third_party_plugin_name

String

Third-party plug-in name

Table 41 keyboard_mouse

Parameter

Type

Description

mouse_feedback

String

VM mouse feedback. Options:

SELFADAPTION: self-adaptive mouse feedback

FORCE: forcible mouse feedback

CLOSE mouse feedback disabled

mouse_simulation_mode

String

VM mouse simulation mode. Options:

ABSOLUTE_POSITION: absolute position simulation

RELATIVE_POSITION: relative position simulation

external_cursor_feedback

Boolean

Indicates whether to enable VM external cursor feedback. Options:

false: no;

true: yes.

Table 42 Bandwidth

Parameter

Type

Description

intelligent_data_transport_flag

String

Indicates whether to enable Intelligent Display Transport (IDT). The value can be DISABLE, ENABLE, or DIAGNOSTIC (diagnosis mode).

total_bandwidth_control_enable

Boolean

Indicates whether to enable total bandwidth control. Options: false: no; true: yes.

options

TotalBandwidthControlOptions object

Total bandwidth options.

display_bandwidth_control_enable

Boolean

Indicates whether to enable display bandwidth control. Options: false: no; true: yes.

display_bandwidth_control_options

DisplayBandwidthControlOptions object

Display bandwidth options.

multimedia_bandwidth_control_enable

Boolean

Indicates whether to enable multimedia bandwidth control. Options: false: no; true: yes.

multimedia_bandwidth_control_options

MultimediaBandwidthControlOptions object

Multimedia bandwidth options.

usb_bandwidth_control_enable

Boolean

Indicates whether to enable USB bandwidth control. Options: false: no; true: yes.

usb_bandwidth_control_options

UsbBandwidthControlOptions object

USB bandwidth options.

pcsc_bandwidth_control_enable

Boolean

Indicates whether to enable PCSC control. Options: false: no; true: yes.

pcsc_bandwidth_control_options

PcscBandwidthControlOptions object

PCSC bandwidth options.

twain_bandwidth_control_enable

Boolean

Indicates whether to enable TWAIN bandwidth control. Options: false: no; true: yes.

twain_bandwidth_control_options

TwainBandwidthControlOptions object

TWAIN bandwidth options.

printer_bandwidth_control_enable

Boolean

Indicates whether to enable printer bandwidth control. Options: false: no; true: yes.

printer_bandwidth_control_options

PrinterBandwidthControlOptions object

Printer bandwidth options.

com_bandwidth_control_enable

Boolean

Indicates whether to enable serial port bandwidth control. Options: false: no; true: yes.

com_bandwidth_control_options

ComBandwidthControlOptions object

Serial port bandwidth options.

file_redirection_bandwidth_control_enable

Boolean

Indicates whether to enable file redirection bandwidth control. Options: false: no; true: yes.

file_redirection_bandwidth_control_options

FileRedirectionBandwidthControlOptions object

File redirection bandwidth options.

clipboard_bandwidth_control_enable

Boolean

Indicates whether to enable clipboard bandwidth control. Options: false: no; true: yes.

clipboard_bandwidth_control_options

ClipboardBandwidthControlOptions object

Clipboard bandwidth options.

secure_channel_bandwidth_control_enable

Boolean

Indicates whether to enable secure channel bandwidth control. Options: false: no; true: yes.

secure_channel_bandwidth_control_options

SecureChannelBandwidthControlOptions object

Secure channel bandwidth options.

camera_bandwidth_control_enable

Boolean

Indicates whether to enable camera bandwidth control. Options: false: no; true: yes.

camera_bandwidth_control_options

CameraBandwidthControlOptions object

Camera bandwidth options.

virtual_channel_bandwidth_control_enable

Boolean

Indicates whether to enable virtual channel bandwidth control. Options: false: no; true: yes.

virtual_channel_bandwidth_control_options

VirtualChannelBandwidthControlOptions object

Virtual channel bandwidth options.

Table 43 TotalBandwidthControlOptions

Parameter

Type

Description

total_bandwidth_control_value

Integer

Total bandwidth control value (kbit/s). The value ranges from 10000 to 1000000. Default value: 30000

display_bandwidth_percentage_enable

Boolean

Indicates whether to enable display bandwidth percentage control. Options: false: no; true: yes.

display_bandwidth_percentage_options

DisplayBandwidthPercentageOptions object

Display bandwidth percentage options.

multimedia_bandwidth_percentage_enable

Boolean

Indicates whether to enable multimedia bandwidth percentage control. Options: false: no; true: yes.

multimedia_bandwidth_percentage_options

MultimediaBandwidthPercentageOptions object

Multimedia bandwidth percentage options.

usb_bandwidth_percentage_enable

Boolean

Indicates whether to enable USB bandwidth percentage control. Options: false: no; true: yes.

usb_bandwidth_percentage_options

UsbBandwidthPercentageOptions object

USB bandwidth percentage options.

pcsc_bandwidth_percentage_enable

Boolean

Indicates whether to enable PCSC bandwidth percentage control. Options: false: no; true: yes.

pcsc_bandwidth_percentage_options

PcscBandwidthPercentageOptions object

PCSC bandwidth percentage options.

twain_bandwidth_percentage_enable

Boolean

Indicates whether to enable TWAIN bandwidth percentage control. Options: false: no; true: yes.

twain_bandwidth_percentage_options

TwainBandwidthPercentageOptions object

TWAIN bandwidth percentage options.

printer_bandwidth_percentage_enable

Boolean

Indicates whether to enable printer bandwidth percentage control. Options: false: no; true: yes.

printer_bandwidth_percentage_options

PrinterBandwidthPercentageOptions object

Printer bandwidth percentage options.

com_bandwidth_percentage_enable

Boolean

Indicates whether to enable serial port bandwidth percentage control. Options: false: no; true: yes.

com_bandwidth_percentage_options

ComBandwidthPercentageOptions object

Serial port bandwidth percentage options.

file_redirection_bandwidth_percentage_enable

Boolean

Indicates whether to enable file redirection bandwidth percentage control. Options: false: no; true: yes.

file_redirection_bandwidth_percentage_options

FileRedirectionBandwidthPercentageOptions object

File redirection bandwidth percentage options.

clipboard_bandwidth_percentage_enable

Boolean

Indicates whether to enable clipboard bandwidth percentage control. Options: false: no; true: yes.

clipboard_bandwidth_percentage_options

ClipboardBandwidthPercentageOptions object

Clipboard bandwidth percentage options.

secure_channel_bandwidth_percentage_enable

Boolean

Indicates whether to enable secure channel bandwidth percentage control. Options: false: no; true: yes.

secure_channel_bandwidth_percentage_options

SecureChannelBandwidthPercentageOptions object

Secure channel bandwidth percentage options.

camera_bandwidth_percentage_enable

Boolean

Indicates whether to enable camera bandwidth percentage control. Options: false: no; true: yes.

camera_bandwidth_percentage_options

CameraBandwidthPercentageOptions object

Camera bandwidth percentage options.

virtual_channel_bandwidth_percentage_enable

Boolean

Indicates whether to enable virtual channel bandwidth percentage control. Options: false: no; true: yes.

virtual_channel_bandwidth_percentage_options

VirtualChannelBandwidthPercentageOptions object

Virtual channel bandwidth percentage options.

Table 44 DisplayBandwidthPercentageOptions

Parameter

Type

Description

display_bandwidth_percentage_value

Integer

Display bandwidth control value (%). The value ranges from 0 to 100. Default value: 65

Table 45 MultimediaBandwidthPercentageOptions

Parameter

Type

Description

multimedia_bandwidth_percentage_value

Integer

Multimedia bandwidth control value (%). The value ranges from 0 to 100. Default value: 50

Table 46 UsbBandwidthPercentageOptions

Parameter

Type

Description

usb_bandwidth_percentage_value

Integer

USB bandwidth control value (%). The value ranges from 0 to 100. Default value: 100

Table 47 PcscBandwidthPercentageOptions

Parameter

Type

Description

pcsc_bandwidth_percentage_value

Integer

PCSC bandwidth control value (%). The value ranges from 0 to 100. Default value: 5

Table 48 TwainBandwidthPercentageOptions

Parameter

Type

Description

twain_bandwidth_percentage_value

Integer

TWAIN bandwidth control value (%). The value ranges from 0 to 100. Default value: 15

Table 49 PrinterBandwidthPercentageOptions

Parameter

Type

Description

printer_bandwidth_percentage_value

Integer

Printer bandwidth control value (%). The value ranges from 0 to 100. Default value: 5

Table 50 ComBandwidthPercentageOptions

Parameter

Type

Description

com_bandwidth_percentage_value

Integer

Serial port bandwidth control value (%). The value ranges from 0 to 100. Default value: 3

Table 51 FileRedirectionBandwidthPercentageOptions

Parameter

Type

Description

file_redirection_bandwidth_percentage_value

Integer

File redirection bandwidth control value (%). The value ranges from 0 to 100. Default value: 30

Table 52 ClipboardBandwidthPercentageOptions

Parameter

Type

Description

clipboard_bandwidth_percentage_value

Integer

Clipboard bandwidth control value (%). The value ranges from 0 to 100. Default value: 3

Table 53 SecureChannelBandwidthPercentageOptions

Parameter

Type

Description

secure_channel_bandwidth_percentage_value

Integer

Secure channel bandwidth control value (%). The value ranges from 0 to 100. Default value: 30

Table 54 CameraBandwidthPercentageOptions

Parameter

Type

Description

camera_bandwidth_percentage_value

Integer

Camera bandwidth control value (%). The value ranges from 0 to 100. Default value: 30

Table 55 VirtualChannelBandwidthPercentageOptions

Parameter

Type

Description

virtual_channel_bandwidth_percentage_value

Integer

Virtual channel bandwidth control value (%). The value ranges from 0 to 100. Default value: 65

Table 56 DisplayBandwidthControlOptions

Parameter

Type

Description

display_bandwidth_control_value

Integer

Display bandwidth control value (kbit/s). The value ranges from 500 to 50000. Default value: 20000

Table 57 MultimediaBandwidthControlOptions

Parameter

Type

Description

multimedia_bandwidth_control_value

Integer

Multimedia bandwidth control value (kbit/s). The value ranges from 5000 to 20000. Default value: 15000

Table 58 UsbBandwidthControlOptions

Parameter

Type

Description

usb_bandwidth_control_value

Integer

USB bandwidth control value (kbit/s). The value ranges from 1000 to 30000. Default value: 30000

Table 59 PcscBandwidthControlOptions

Parameter

Type

Description

pcsc_bandwidth_control_value

Integer

PCSC bandwidth control value (kbit/s). The value ranges from 1000 to 5000. Default value: 2000

Table 60 TwainBandwidthControlOptions

Parameter

Type

Description

twain_bandwidth_control_value

Integer

TWAIN bandwidth control value (kbit/s). The value ranges from 2000 to 10000. Default value: 5000

Table 61 PrinterBandwidthControlOptions

Parameter

Type

Description

printer_bandwidth_control_value

Integer

Printer bandwidth control value (kbit/s). The value ranges from 1000 to 5000. Default value: 2000

Table 62 ComBandwidthControlOptions

Parameter

Type

Description

com_bandwidth_control_value

Integer

Serial port bandwidth control value (kbit/s). The value ranges from 500 to 2000. Default value: 1000

Table 63 FileRedirectionBandwidthControlOptions

Parameter

Type

Description

file_redirection_bandwidth_control_value

Integer

File redirection bandwidth control value (kbit/s). The value ranges from 500 to 20000. Default value: 10000

Table 64 ClipboardBandwidthControlOptions

Parameter

Type

Description

clipboard_bandwidth_control_value

Integer

Clipboard bandwidth control value (kbit/s). The value ranges from 100 to 2000. Default value: 1000

Table 65 SecureChannelBandwidthControlOptions

Parameter

Type

Description

secure_channel_bandwidth_control_value

Integer

Secure channel bandwidth control value (kbit/s). The value ranges from 500 to 20000. Default value: 10000

Table 66 CameraBandwidthControlOptions

Parameter

Type

Description

camera_bandwidth_control_value

Integer

Camera bandwidth control value (kbit/s). The value ranges from 0 to 10000. Default value: 10000

Table 67 VirtualChannelBandwidthControlOptions

Parameter

Type

Description

virtual_channel_bandwidth_control_value

Integer

Virtual channel bandwidth control value (kbit/s). The value ranges from 500 to 20000. Default value: 20000

Table 68 custom

Parameter

Type

Description

custom_configuration1_enable

Boolean

Indicates whether to enable custom policy configuration item 1. Options:

false: no

true: yes

options

CustomOptions object

Custom policy options

Table 69 CustomOptions

Parameter

Type

Description

custom_configuration1_rule

String

Configuration item 1

rail_transparent_config

RailTransparentConfig object

Application image policy settings.

Table 70 RailTransparentConfig

Parameter

Type

Description

select_policy

Integer

Policy configuration principle.

transparent_list_custom

String

Configuration item.

Table 71 cloud_storage

Parameter

Type

Description

cloud_storage_enable

Boolean

Whether to enable cloud storage:

false: disabled

true: enabled

options

CloudStorageOptions object

Cloud storage configuration.

Table 72 CloudStorageOptions

Parameter

Type

Description

cloud_storage_rule

String

Configuration item.

Table 73 user_profile

Parameter

Type

Description

user_profile_enable

Boolean

Whether to enable profile roaming.

false: disabled

true: enabled

options

UpmOptions object

Profile roaming.

Table 74 UpmOptions

Parameter

Type

Description

user_profile_rule

String

Configuration item.

redir_exclude_common_folders

String

Excludes common folders.

redir_exclude_copy0s

String

Prohibits custom folders/copy base = 0, copy back = 0.

redir_exclude_copy1s

String

Prohibits custom folders/copy base = 0, copy back = 1.

redir_exclude_copy2s

String

Prohibits custom folders/copy base = 1, copy back = 0.

redir_exclude_copy3s

String

Prohibits custom folders/copy base = 1, copy back = 1.

redir_exclude_includes

String

Allows for customized folders.

Table 75 url_redirection

Parameter

Type

Description

url_redirection_enable

Boolean

URL redirection status.

false: disabled

true: enabled

options

UrlRedirectionOptions object

URL redirection configuration.

Table 76 UrlRedirectionOptions

Parameter

Type

Description

url_include_list

String

URLs that are allowed for redirection.

url_exclude_list

String

URLs that are rejected for redirection.

Table 77 folder_redirection

Parameter

Type

Description

folder_redirection_status

Integer

Folder redirection status.

0: disabled

1: enabled

2: not configured

options

FolderRedirectionOptions object

Configuration of folder redirection.

Table 78 FolderRedirectionOptions

Parameter

Type

Description

relative_path

String

Location of the target folder.

storage_paths

String

User storage path.

include_common_folders

Integer

Folder option.

Table 79 folder_redirection_v2

Parameter

Type

Description

folder_redirection_v2_status

Integer

Folder redirection status.

0: disabled.

1: enabled.

options

FolderRedirectionV2Options object

Folder redirection configuration (v2).

Table 80 FolderRedirectionV2Options

Parameter

Type

Description

app_data_roaming_configurations

AppDataRoamingConfigurations object

AppData (Roaming) folder redirection configuration.

desktop_configurations

DesktopConfigurations object

Desktop folder redirection configuration.

start_menu_configurations

StartMenuConfigurations object

Start menu folder redirection configuration.

documents_configurations

DocumentsConfigurations object

Documents folder redirection configuration.

pictures_configurations

PicturesConfigurations object

Pictures folder redirection configuration.

music_configurations

MusicConfigurations object

Music folder redirection configuration.

videos_configurations

VideosConfigurations object

Video folder redirection configuration.

favorites_configurations

FavoritesConfigurations object

Favorites folder redirection configuration.

contacts_configurations

ContactsConfigurations object

Contacts folder redirection configuration.

downloads_configurations

DownloadsConfigurations object

Downloads folder redirection configuration.

links_configurations

LinksConfigurations object

Link folder redirection configuration.

searches_configurations

SearchesConfigurations object

Search folder redirection configuration.

saved_games_configurations

SavedGamesConfigurations object

Saved games folder redirection configuration.

Table 81 AppDataRoamingConfigurations

Parameter

Type

Description

app_data_roaming_status

Integer

Folder redirection status.

0: not selected.

1: selected.

app_data_roaming_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

app_data_roaming_storage_path

String

User storage path for folder redirection (v2).

app_data_roaming_relative_path

String

Location of the target folder.

app_data_roaming_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

app_data_roaming_move_contents

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

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 82 DesktopConfigurations

Parameter

Type

Description

desktop_status

Integer

Folder redirection status.

0: not selected.

1: selected.

desktop_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

desktop_storage_path

String

User storage path for folder redirection (v2).

desktop_relative_path

String

Location of the target folder.

desktop_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

desktop_move_contents

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

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 StartMenuConfigurations

Parameter

Type

Description

start_menu_status

Integer

Folder redirection status.

0: not selected.

1: selected.

start_menu_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

start_menu_storage_path

String

User storage path for folder redirection (v2).

start_menu_relative_path

String

Location of the target folder.

start_menu_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

start_menu_move_contents

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

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 DocumentsConfigurations

Parameter

Type

Description

documents_status

Integer

Folder redirection status.

0: not selected.

1: selected.

documents_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

documents_storage_path

String

User storage path for folder redirection (v2).

documents_relative_path

String

Location of the target folder.

documents_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

documents_move_contents

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

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 PicturesConfigurations

Parameter

Type

Description

pictures_status

Integer

Folder redirection status.

0: not selected.

1: selected.

pictures_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

pictures_storage_path

String

User storage path for folder redirection (v2).

pictures_relative_path

String

Location of the target folder.

pictures_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

pictures_move_contents

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

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 MusicConfigurations

Parameter

Type

Description

music_status

Integer

Folder redirection status.

0: not selected.

1: selected.

music_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

music_storage_path

String

User storage path for folder redirection (v2).

music_relative_path

String

Location of the target folder.

music_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

music_move_contents

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

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 VideosConfigurations

Parameter

Type

Description

videos_status

Integer

Folder redirection status.

0: not selected.

1: selected.

videos_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

videos_storage_path

String

User storage path for folder redirection (v2).

videos_relative_path

String

Location of the target folder.

videos_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

videos_move_contents

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

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 FavoritesConfigurations

Parameter

Type

Description

favorites_status

Integer

Folder redirection status.

0: not selected.

1: selected.

favorites_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

favorites_storage_path

String

User storage path for folder redirection (v2).

favorites_relative_path

String

Location of the target folder.

favorites_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

favorites_move_contents

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

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 ContactsConfigurations

Parameter

Type

Description

contacts_status

Integer

Folder redirection status.

0: not selected.

1: selected.

contacts_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

contacts_storage_path

String

User storage path for folder redirection (v2).

contacts_relative_path

String

Location of the target folder.

contacts_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

contacts_move_contents

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

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 DownloadsConfigurations

Parameter

Type

Description

downloads_status

Integer

Folder redirection status.

0: not selected.

1: selected.

downloads_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

downloads_storage_path

String

User storage path for folder redirection (v2).

downloads_relative_path

String

Location of the target folder.

downloads_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

downloads_move_contents

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

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 LinksConfigurations

Parameter

Type

Description

links_status

Integer

Folder redirection status.

0: not selected.

1: selected.

links_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

links_storage_path

String

User storage path for folder redirection (v2).

links_relative_path

String

Location of the target folder.

links_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

links_move_contents

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

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 SearchesConfigurations

Parameter

Type

Description

searches_status

Integer

Folder redirection status.

0: not selected.

1: selected.

searches_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

searches_storage_path

String

User storage path for folder redirection (v2).

searches_relative_path

String

Location of the target folder.

searches_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

searches_move_contents

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

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 SavedGamesConfigurations

Parameter

Type

Description

saved_games_status

Integer

Folder redirection status.

0: not selected.

1: selected.

saved_games_redirection_type

Integer

Folder redirection type.

0: remote.

1: local.

saved_games_storage_path

String

User storage path for folder redirection (v2).

saved_games_relative_path

String

Location of the target folder.

saved_games_exclusive_rights

Integer

Whether to enable the exclusive control permission of a user on the folder.

0: disabled.

1: enabled.

saved_games_move_contents

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

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 user_profile_management

Parameter

Type

Description

upm_status

Integer

User configuration status.

0: disabled

1: enabled

2: not configured

options

UserProfileManagementOptions object

User roaming configuration.

Table 95 UserProfileManagementOptions

Parameter

Type

Description

profiles

UserProfileManagementProfiles object

Configuration of user roaming profile.

Table 96 UserProfileManagementProfiles

Parameter

Type

Description

vhd_write_back

String

VHD session write-back status.

0: disabled

1: enabled

2: not configured

Status code: 400

Table 97 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 98 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 99 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 100 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 101 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 102 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 103 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/policy-groups/actions/list-original-policy

Example Responses

Status code: 200

Response to querying policy group items.

{
  "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" : "string",
          "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" : "string"
          }
        },
        "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" : 25,
        "video_frame_rate" : 30,
        "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" : "Quality 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" : false,
      "rendering_acceleration_options" : {
        "video_acceleration_enhancement_enable" : false,
        "video_optimization_enable" : false,
        "gpu_color_optimization_enable" : false
      },
      "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" : "\\\\home",
          "linux_file_mount_path" : "\\\\media|\\\\Volumes|\\\\swdb\\\\mnt|\\\\home|\\\\storage|\\\\tmp|\\\\run\\\\media",
          "linux_fixed_drive_file_system_format" : "string",
          "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" : true,
        "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"
      }
    },
    "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" : 480
          }
        }
      }
    },
    "virtual_channel" : {
      "virtual_channel_control_enable" : false,
      "options" : {
        "custom_virtual_channel_name" : "string",
        "virtual_channel_plugin_details" : "string",
        "third_party_plugin_name" : "string"
      }
    },
    "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" : "string"
      }
    }
  }
}

Status Codes

Status Code

Description

200

Response to querying policy group items.

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.