请求地址:

请求地址请求方法
/api/agent/configPOST

请求参数

参数类型是否必填最大长度描述示例值
 clientidString32代理客户端ID
modeInt1响应模式:0同步、1异步,默认为1,各差异如下:

同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败)

异步:服务器会立即响应客户端,通过任务ID获得任务执行结果


返回示例

{
    "TaskID":"685dab7980f9f9845b5e729d5de75a89",
    "Describe":"代理客户端配置信息",
    "Content":{
        "client":{
            "config":{
                "VMwareOVFTool_ovf_save_path":"D:/360MoveData/Users/Administrator/Desktop/ovf",
                "VMwareOVFTool_ovf_tool":"E:/AuxEsxi/bin/ovftool/win/VMwareOVFToolx64/ovftool.exe",
                "app_run_filename":"C:/b001/exe/main.exe",
                "basic_data_path":"E:/AuxEsxi/data2/",
                "basic_id":"76803510cea5fbbfeeeb86d608d381fa",
                "basic_log_path":"E:/AuxEsxi/data2/AuxEsxiAgent.log",
                "basic_vm_filter_vmid":"12",
                "config":"E:/AuxEsxi/conf/agent.conf",
                "config_path":"E:/AuxEsxi/conf/",
                "esxi_ssh_data_name":"data_1t",
                "esxi_ssh_host":"192.168.0.2",
                "esxi_ssh_new_vm_path":"/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c29/user/",
                "esxi_ssh_paw":"...",
                "esxi_ssh_port":"22",
                "esxi_ssh_user":"root",
                "server_api_host":"http://127.0.0.1:4149/",
                "server_api_key":"1313DPZdfDHzjJ4F4w3x8asmCzcyydzpp",
                "server_host":"127.0.0.1:4142",
                "server_node":"single",
                "socket_create_hostname_rule":"pc-yun-{vmid}",
                "socket_port":"19871",
                "socket_skey":"123456",
                "vmtpl_file_tpl_clone":"E:/AuxEsxi/conf/tpl_clone.conf",
                "vmtpl_file_tpl_ovf":"E:/AuxEsxi/conf/tpl_ovf.conf",
                "vmtpl_mode":"clone"
            },
            "tpl_clone":[
                {
                    "describe":"win7x64",
                    "name":"win7",
                    "path":"/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/tpl-win7x64"
                },
                {
                    "describe":"win7x64",
                    "name":"win8",
                    "path":"/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/tpl-win7x64"
                },
                {
                    "describe":"win7x64",
                    "name":"win10",
                    "path":"/vmfs/volumes/5e5b23b2-a4e7fb00-8d08-c4834f165c2c/tpl-win7x64"
                }
            ],
            "tpl_ovf":[
                {
                    "describe":"win7",
                    "name":"win7",
                    "path":"D:/ovf/tpl-win7x64/tpl-win7x64.ovf"
                },
                {
                    "describe":"win10",
                    "name":"win10",
                    "path":"D:/ovf/tpl-win7x64/tpl-win7x64.ovf"
                }
            ]
        },
        "task":{
            "event_name":"EVENT_AGENT_CLIENT_CONFIG",
            "task_errcode":"200",
            "task_errmsg":"success"
        }
    },
    "InsertTime":1700055672,
    "UpdateTime":1700055672,
    "ExpireTime":1700142072
}

返回参数说明

参数描述
config配置信息
    VMwareOVFTool_ovf_save_path导出OVF模板存放路径
    VMwareOVFTool_ovf_toolOVFTool文件所在目录
    app_run_filename程序运行时路径
    basic_data_path绑定数据目录
    basic_id客户端ID
    basic_log_path

日志文件

    basic_vm_filter_vmid对于客户机没有安装VMware Tools的虚拟机,启用过滤后,系统不会再检测虚拟机IP地址
    config配置文件
    config_path配置文件所在路径
    esxi_ssh_data_name默认ESXI数据存储名称
    esxi_ssh_hostESXI的SSH主机地址
    esxi_ssh_new_vm_path创建虚拟机时默认保存路径
    esxi_ssh_pawESXI的SSH登录密码
    esxi_ssh_portESXI的SSH服务器端口
    esxi_ssh_userESXI的SSH用户名
    server_api_hostAPI服务器地址(IP:端口)
    server_api_keyAPI服务器密钥
    server_host通讯服务器地址(IP:端口)
    socket_create_hostname_rule自动生成主机名规则
    socket_port作为与被控端连接通讯端口
    socket_skey作为与被控端连接通讯密钥
    vmtpl_file_tpl_clone克隆虚拟机模板配置文件
    vmtpl_file_tpl_ovf导入OVF模板配置文件
    vmtpl_mode虚拟机模板模式:clone(克隆模板)、ovf(ovf模板)
tpl_clone克隆模板配置信息
    name模板名称
    describe模板描述
    path模板所在路径
tpl_ovfOVF模板配置信息
    name模板名称
    describe模板描述
    path模板所在路径

异常示例

{"errcode":"500","errmsg":"内部错误"}