xshell script api

Xshell支持使用VB,JS,Python脚本去启动自动化任务。这里介绍一下xshell提供的API，并且提供一个python包xsh提高开发效率。

xsh.Seesion

The following functions and variables can be used in Xshell sessions. To use these functions and variables, execute them together with xsh.Session. For example, to use ‘Sleep()’ function, use ‘xsh.Session.Sleep(1000)’.

Return Value	Function	Parameter	Description
Void	Open(LPCTSTR lpszSession)	lpszSession A character string of an Xshell session path or URL format of Xshell.	Open a new session or URL. To open a session, place /s option in front of a character string. Ex.) To open the A.xsh session, use ‘/s $PATH/A.xsh’.
Void	Close()		Close the currently connected session.
Void	Sleep(long timeout)	Timeout Milisecond unit time value.	Make Xshell wait for the designated time.
Void	LogFilePath(LPCTSTR lpszNewFilePath)	lpszNewFilePath File name including path	Designate log file.
void	StartLog()		Start logging for a session. Log is designated with a path specified in LogFilePath(). If a log file path is not designated, the default path is used.
void	StopLog()		Stop logging.

Name	Type	Description
Connected	BOOL	Check whether current session is connected.
LocalAddress	BSTR	Retrieve the local address.
Path	BSTR	Retrieve the current session file path.
RemoteAddress	BSTR	Retrieve the remote address.
RemotePort	long	Retrieve the remote port.
Logging	BOOL	Check whether current session is recording log file.
LogFilePath	BSTR	Save as a log file.

xsh.Screen

The following functions and variables can be used when handling of the Xshell terminal screen. To use these functions and variables, execute them together with the xsh.Screen. For example, to use ‘Clear()’ function, use ‘xsh.Session.Clear()’.

Return Value	Function	Parameter	Description
void	Clear()		Clear terminal screen.
void	Send(LPCTSTR lpszStrToSend)	lpszStrToSend Character string to send	Send message to terminal.
BSTR	Get(long nBegRow, long nBegCol, long nEndRow, long nEndCol)	nBegRow Terminal row starting position nBegCol Terminal column starting position nEndRow Terminal row ending position nEndCol Terminal column ending position	Read the character string in the specified terminal section and return the value.
void	WaitForString(LPCTSTR lpszString)	lpszString Character string to be displayed on the terminal.	Wait for message.
Long	WaitForStrings(VARIANT FAR* strArray, long nTimeout)	strArray Character string to be displayed on the terminal nTimeout Wait time millisecond value Return Value The number of found strings.	Wait for message until timeout.

Name	Type	Description
CurrentColumn	long	Return the current column.
CurrentRow	long	Return the current row.
Columns	long	Retrieve the total columns same as terminal width.
Rows	long	Retrieves the total row same as terminal lines
Synchronous	BOOL	Set screen synchronization (True means synchronize and false means do not synchronize)

xsh.Dialog

You can use this to manipulate the Xshell terminal screen. To use the following function and variable, execute it with xsh.Dialog. For example, if you want to use the MsgBox() function, append xsh.Dialog.MsgBox() in the front like this: xsh.Dialog.MsgBox().

Return Value	Function	Parameter	Description
Long	MsgBox(LPCTSTR lpszMsg)	LpszMsg: String you want to send.	Open a message box.
string	Prompt(LPCTSTR lpszMessage, LPCTSTR lpszTitle, LPCTSTR lpszDefault, BOOL bHidden)	lpszMessage: The string to be displayed in the Prompt Dialog Box lpszTitle: The string to be displayed in the title bar of the Prompt Dialog Box lpszDefault: Initial default string of Prompt Dialog Box input box bHidden: If set to True, input will be hidden (e.g. *****)	Description: Returns user’s input from Prompt Dialog Box Return Values: User’s input from Prompt Dialog Box
int	MessageBox(LPCTSTR lpszMessage, LPCTSTR lpszTitle, int nType)	lpszMessage: The string to be displayed in the Message Box lpszTitle: The string to be displayed in the title bar of the Message Box nType: Dictates button types. Refer to the table below	Description: Displays a message box with a variety of buttons and return values depending on the user’s button selection Return Values: Refer to the nType parameter description below

nType	Button	Return Value
0	OK	1
1	OK / Cancel	1 / 2
2	Abort / Retry / Ignore	3 / 4 / 5
3	Yes / No / Cancel	6 / 7 / 2
4	Yes / No	6 / 7
5	Retry / Cancel	4 / 2
6	Cancel / TryAgain / Continue	2 / 10 / 11

xshell官网原文：https://netsarang.atlassian.net/wiki/spaces/ENSUP/pages/419957269/Script+API

由于直接通过这些API去开发Xshell的python脚本，可能由于拼写等原因，不能顺畅的开发，所以我将官方的API打包，用python写了一个同名的xsh包，API接口和官方完全一致，并提供详细的注释，通过这个包，可以大大提供开发效率，在使用时，也仅仅只需要注释掉导入包的语句即可。

项目地址：https://github.com/AZMDDY/xshapi

xshell 执行脚本API介绍(附带xsh的python包)相关推荐

MicroFocus 监控工具 SiteScope 搭配Task scheduler在远程Windows上执行脚本
文章目录 SiteScope介绍配置步骤 1.在远程被监控Windows上准备工作 2.SiteScope端配置 3.设置SiteScope 总结 SiteScope介绍 SiteScope 是HP ...
Xshell 执行python脚本
XShell支持使用VB,JS,Python脚本去启动自动化任务.这里介绍如何写Xshell的Python脚本. 首先要在脚本中定义一个Main()函数,Xshell会调用这个函数,也就是程序的入口. ...
Ansible介绍、安装、远程执行命令、拷贝文件或者目录、远程执行脚本
Ansible介绍不需要安装客户端,通过sshd去通信基于模块工作,模块可以由任何语言开发不仅支持命令行使用模块,也支持编写yaml格式的playbook,易于编写和阅读安装十分简单,cent ...
xshell执行sql脚本
xshell执行sql脚本上传文件见上一篇博客 1.通过xshell连接mysql 2.将服务器上目的目录中的sql文件导入注意:一定要先选择一个数据库 3.此时test数据库中已经多了一张&qu ...
ansible介绍、安装、远程执行命令、拷贝文件或目录、远程执行脚本、管理任务计划、安装包和管理服务、playbook、变量、循环、条件判断、handlers、安装nginx、管理配置文件
24.15 ansible介绍 ansible是新出现的自动化运维工具,基于Python开发,集合了众多运维工具(puppet.cfengine.chef.func.fabric)的优点,实现了批量系 ...
xshell自动化脚本
xshell具有脚本功能,可以实现很多自动化的操作. 从xshell的官方手册,可以知道xshell的脚本分为3类: xsh.Session 下面的函数或变量在xshell会话中使用,使用的时候要指定 ...
elasticsearch 6.x (五) 单一文档 API 介绍和使用 update和delete API
大家好,我是烤鸭: 今天分享的是官网6.x 单一文档(Single document APIs)APIs. 本文这是部分翻译,如果想看全部的,还是建议阅读官方api.链接: https://ww ...
有生之年转ta系列4pc手机图形api介绍
本文内容来自 [技术美术百人计划]图形 1.4 PC手机图形API介绍观后记录美术岗位代码或者算法一类的问题可能不太懂本文仅用来记录学习,如果有不对的请指出谢谢图形部分第一章 4纹理基础前 ...
Python+Selenium 自动化测试 2. Webdriver API介绍
目录一 Webdriver介绍二 webdriver实现的原理三 API介绍 Webdriver 元素的查找的八种方式 find_element_by_id() 源码 find_elemen ...
(转)ASP.NET 脚本语言介绍
(转自) http://www.72e.net/support/docread-99.aspx Asp.Net 脚本语言介绍查看次数:117017 更新时间:2005-11-27 ...

xshell 执行脚本API介绍(附带xsh的python包)

xshell script api

xsh.Seesion

xsh.Screen

xsh.Dialog

xshell 执行脚本API介绍(附带xsh的python包)相关推荐

最新文章

热门文章