本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
创建会话
使用指定的详细信息创建一个新的 NICE DCV 会话。
请求参数
Name
-
会话的名称。
类型: 字符串
:必需 是
Owner
-
会话拥有者的名称。这必须是目标 NICE DCV 服务器上现有用户的名称。
类型: 字符串
:必需 是
Type
-
会话类型。有关会话类型的更多信息,请参阅NICE DCV 会议简介中的NICE DCV 管理员指南.
有效值:控制台 | 虚拟
类型: 字符串
:必需 是
InitFile
-
在 Linux NICE DCV 服务器上支持将虚拟会话一起使用。Windows 和 Linux NICE DCV 服务器上不支持控制台会话使用。在 NICE DCV 服务器上运行的自定义脚本的路径,以便在创建会话时初始化会话。文件路径相对于为
agent.init_folder
代理配置参数。如果文件位于指定的 init 目录中,请仅指定文件名。如果文件不在指定的 init 目录中,请指定相对路径。有关详细信息,请参阅。代理配置文件中的NICE DCV 会话管理器管理员指南.类型: 字符串
:必需 否
MaxConcurrents
-
并发 NICE DCV 客户端的最大数量。
类型: 整数
:必需 否
DcvGlEnabled
-
指示虚拟会话是否配置为使用基于硬件的 OpenGL。仅支持虚拟会话。Windows NICE DCV 服务器不支持此参数。
有效值:true | false
类型: 布尔值
:必需 否
PermissionsFile
-
权限文件的 base64 编码内容。如果省略,则默认为服务器默认值。有关更多信息,请参阅 。配置 NICE DCV 授权中的NICE DCV 管理员指南.
类型: 字符串
:必需 否
EnqueueRequest
-
指示如果无法立即履行请求,是否将请求排队。
类型: 布尔值
原定设置值:false
:必需 否
AutorunFile
-
支持 Windows NICE DCV 服务器上的控制台会话和(在 Linux NICE DCV 服务器上)支持控制台会话。Linux NICE DCV 服务器上不支持控制台会话使用。
主机服务器上要在会话内运行的文件的路径。文件路径相对于为
agent.autorun_folder
代理配置参数。如果文件位于指定的自动运行目录中,请仅指定文件名。如果文件不在指定的自动运行目录中,请指定相对路径。有关更多信息,请参阅 。代理配置文件中的NICE DCV 会话管理器管理员指南.该文件代表指定的所有者. 指定的所有者必须具有在服务器上运行文件的权限。在 Windows NICE DCV 服务器上,当所有者登录会话时,该文件将运行。在 Linux NICE DCV 服务器上,创建会话时将运行文件。
类型: 字符串
:必需 否
AutorunFileArguments
-
在 Linux NICE DCV 服务器上支持将虚拟会话一起使用。Windows 和 Linux NICE DCV 服务器上的控制台会话中不支持控制台会话。传递到命令行参数自动运行文件在会话内执行时。参数按照出现在给定数组中的顺序传递。可以配置允许的最大参数数和每个参数的最大允许长度。有关更多信息,请参阅 。代理配置文件中的NICE DCV 会话管理器管理员指南.
类型: 字符串数组
:必需 否
DisableRetryOnFailure
-
指示在由于任何原因在 NICE DCV 主机上失败之后,是否不重试创建会话请求。有关创建会话重试机制的更多信息,请参阅代理配置文件中的NICE DCV 会话管理器管理员指南.
类型: 布尔值
原定设置值:false
:必需 否
Requirements
-
为了放置会话,服务器必须满足的要求。这些要求可以包括服务器标记和/或服务器属性,通过调用DescribeServersAPI。
要求条件表达式:
一个
! =b
如果 true一个
不等于b
一个
=b
如果 true一个
等于b
一个
>b
如果 true一个
大于号b
一个
>=b
如果 true一个
大于或等于b
一个
<b
如果 true一个
小于号b
一个
<=b
如果 true一个
小于或等于b
一个
=b
如果 true一个
包含字符串b
要求布尔运算符:
一个
和b
如果 true一个
和b
is true一个
要么b
如果 true一个
要么b
is true不
一个
如果 true一个
is false
标签密钥必须以前缀为
tag:
,服务器属性必须以前缀为server:
。要求表达式支持括号()
.要求示例:
tag:color = 'pink' and (server:Host.Os.Family = 'windows' or tag:color := 'red')
"server:Host.Aws.Ec2InstanceType := 't2' and server:Host.CpuInfo.NumberOfCpus >= 2"
数值可以使用指数表示法指定,例如:
"server:Host.Memory.TotalBytes > 1024E6"
.支持的服务器属性包括:
Id
Hostname
Version
SessionManagerAgentVersion
Host.Os.BuildNumber
Host.Os.Family
Host.Os.KernelVersion
Host.Os.Name
Host.Os.Version
Host.Memory.TotalBytes
Host.Memory.UsedBytes
Host.Swap.TotalBytes
Host.Swap.UsedBytes
Host.CpuLoadAverage.OneMinute
Host.CpuLoadAverage.FiveMinutes
Host.CpuLoadAverage.FifteenMinutes
Host.Aws.Ec2InstanceId
Host.Aws.Ec2InstanceType
Host.Aws.Region
Host.Aws.Ec2ImageId
Host.CpuInfo.Architecture
Host.CpuInfo.ModelName
Host.CpuInfo.NumberOfCpus
Host.CpuInfo.PhysicalCoresPerCpu
Host.CpuInfo.Vendor
类型: 字符串
:必需 否
StorageRoot
-
指定用于会话存储的文件夹的路径。有关 NICE DCV 会话存储的更多信息,请参阅启用会话存储中的NICE DCV 管理员指南.
类型: 字符串
:必需 否
响应参数
Id
-
会话的唯一 ID。
Name
-
会话名称。
Owner
-
会话拥有者。
Type
-
会话的类型。
State
-
会话的状态。如果请求成功完成,会话将输入
CREATING
状态。