hp服务器 iLO远程管理 python api模块 hpilo-python 接口列表

一时失言乱红尘 2021-09-02 03:20 407阅读 0赞

**iLO****模块开发所用到的API****信息列表和测试结果文档**

Hpilo接口信息归纳：

类: Ilo

方法及返回：**(****红色标记为用处较大的接口)**

activate\_license(key)：激活Ilo高级许可证。

add\_user(user\_login, user\_name, password, admin\_priv=False, remote\_cons\_priv=True, reset\_server\_priv=False, virtual\_media\_priv=False, config\_ilo\_priv=True)：添加管理用户

ahs\_clear\_data()：清除当前系统日志

call\_delayed()：延时模式

certificate\_signing\_request(country=None, state=None, locality=None, organization=None, organizational\_unit=None, common\_name=None)：获取签名证书

clear\_ilo\_event\_log()：清除ILO事件日志

clear\_server\_event\_log()：清除服务器事件日志

clear\_server\_power\_on\_time()：清理服务器上电时间

cold\_boot\_server()：强制冷启动服务器

computer\_lock\_config(computer\_lock=None, computer\_lock\_key=None)：配置电脑锁设置

delete\_ssh\_key(user\_login)：删除一个用户SSH密钥

delete\_user(user\_login)：删除指定用户

disable\_ers()：

eject\_virtual\_floppy()：弹出虚拟软盘

eject\_virtual\_media(device='cdrom')：弹出指定设备的媒介

factory\_defaults()：恢复出厂设置

ers\_ahs\_submit(message\_id, bb\_days)：

fips\_enable()：使fips标准加密生效，只能恢复出厂设置，重置用户名密码和证书

get\_ahs\_status()：获取有效良好系统状态记录

get\_all\_cables\_status()：

get\_all\_languages()：获取列表的安装语言——破因为iLO返回无效的XML

get\_all\_licenses()：获得一个列表的所有许可类型和许可证

get\_all\_user\_info()：获取用户基本和授权信息

get\_all\_users()：获取用户登录列表

get\_asset\_tag()：获取服务器资产标签

get\_cert\_subject\_info()：获得ssl证书主题信息

get\_diagport()：未知

get\_ers\_settings()：让获得ERS远程支持设置

get\_dir\_config()：获得目录认证配置

get\_embedded\_health()：获取服务器的健康信息

get\_enclosure\_ip\_settings()：未知

get\_fips\_status()：是fips授权/ 3 desencryption AES执行到位

get\_fw\_version()：获得ILO的固件版本

get\_global\_settings()：获得ILO的全局设置

get\_host\_data(*decoded\_only=True*)：得到描述主机的SMBIOS记录。默认情况下只有用户可读的信息可以返回。获取所有记录通过decoded\_only=False

get\_host\_power\_reg\_info()：未知

get\_host\_power\_saver\_status()：得到功率调节器的配置

get\_host\_power\_status()：服务器是否上电

get\_host\_pwr\_micro\_ver():获得版本的功率小固件

get\_ilo\_event\_log()：得到ilo的事件日志

get\_network\_settings():得到ilo的网络设置

get\_oa\_info(): 得到信息的封闭的OA底盘

get\_one\_time\_boot():获得主机的一次启动状态

get\_pers\_mouse\_keyboard\_enabled():返回是否启用了持久的鼠标和键盘

get\_persistent\_boot():获取主机的启动顺序

get\_power\_cap():得到电源上限设置

get\_power\_readings()：得到电流、最小、最大和平均功率读数

get\_pwreg()：获得电源和电源警报阈值设置

get\_security\_msg()：在登录屏幕显示检索安全消息

get\_server\_auto\_pwr()：得到自动延时上电设置

get\_server\_event\_log()：从服务器上获取IML 日志

get\_server\_name()：获取服务器的名称

get\_server\_power\_on\_time()：服务器开机时间

get\_snmp\_im\_settings()：ILO在哪里发送SNMP陷阱,这陷阱是否发送

get\_spatial()：获得本地信息

get\_sso\_settings()：获得惠普SIM单点登录设置

get\_topology()：

get\_twofactor\_settings():获得双重认证设置

get\_uid\_status()：获得UID权限状态

get\_user(*user\_login*)：得到特定的一个用户信息

get\_vf\_status()：

get\_vm\_status(*device='CDROM'*)：得到虚拟媒体设备的状态。有效的设备可以是软盘和光盘

get\_vpb\_capable\_status()：

hold\_pwr\_btn()：长按电源按钮。

hotkey\_config(*ctrl\_t=None*, *ctrl\_u=None*, *ctrl\_v=None*, *ctrl\_w=None*, *ctrl\_x=None*, *ctrl\_y=None*)：修改一组快捷键

import\_certificate(*certificate*)：导入一个有效的SSL证书

import\_ssh\_key(*user\_login*, *ssh\_key*)：导入一个SSH密钥为指定的用户。ssh密钥的值应该是id\_dsa.pub文件内容。

insert\_virtual\_media(*device*, *image\_url*)：插入一个虚拟软盘或光盘。请注意,您还需要使用[set\_vm\_status()][set_vm_status]连接媒体

mod\_dir\_config(*dir\_authentication\_enabled=None*, *dir\_local\_user\_acct=None*, *dir\_server\_address=None*, *dir\_server\_port=None*, *dir\_object\_dn=None*, *dir\_object\_password=None*, *dir\_user\_context\_1=None*, *dir\_user\_context\_2=None*, *dir\_user\_context\_3=None*, *dir\_user\_context\_4=None*, *dir\_user\_context\_5=None*, *dir\_user\_context\_6=None*, *dir\_user\_context\_7=None*, *dir\_user\_context\_8=None*, *dir\_user\_context\_9=None*, *dir\_user\_context\_10=None*, *dir\_user\_context\_11=None*, *dir\_user\_context\_12=None*, *dir\_user\_context\_13=None*, *dir\_user\_context\_14=None*, *dir\_user\_context\_15=None*, *dir\_enable\_grp\_acct=None*, *dir\_kerberos\_enabled=None*, *dir\_kerberos\_realm=None*, *dir\_kerberos\_kdc\_address=None*, *dir\_kerberos\_kdc\_port=None*, *dir\_kerberos\_keytab=None*, *dir\_grpacct1\_name=None*, *dir\_grpacct1\_sid=None*, *dir\_grpacct1\_priv=None*, *dir\_grpacct2\_name=None*, *dir\_grpacct2\_sid=None*, *dir\_grpacct2\_priv=None*, *dir\_grpacct3\_name=None*, *dir\_grpacct3\_sid=None*, *dir\_grpacct3\_priv=None*, *dir\_grpacct4\_name=None*, *dir\_grpacct4\_sid=None*, *dir\_grpacct4\_priv=None*, *dir\_grpacct5\_name=None*, *dir\_grpacct5\_sid=None*, *dir\_grpacct5\_priv=None*, *dir\_grpacct6\_name=None*, *dir\_grpacct6\_sid=None*, *dir\_grpacct6\_priv=None*)：修ILO的目录配置,只有指定的值将被改变。

mod\_global\_settings(*session\_timeout=None*, *f8\_prompt\_enabled=None*, *f8\_login\_required=None*, *lock\_configuration=None*, *ilo\_funct\_enabled=None*, *serial\_cli\_status=None*, *serial\_cli\_speed=None*, *http\_port=None*, *https\_port=None*, *ssh\_port=None*, *ssh\_status=None*, *vmedia\_disable=None*, *virtual\_media\_port=None*, *remote\_console\_port=None*, *snmp\_access\_enabled=None*, *snmp\_port=None*, *snmp\_trap\_port=None*, *remote\_syslog\_enable=None*, *remote\_syslog\_server\_address=None*, *remote\_syslog\_port=None*, *alertmail\_enable=None*, *alertmail\_email\_address=None*, *alertmail\_sender\_domain=None*, *alertmail\_smtp\_server=None*, *min\_password=None*, *enfoce\_aes=None*, *authentication\_failure\_logging=None*, *rbsu\_post\_ip=None*, *remote\_console\_encryption=None*, *remote\_keyboard\_model=None*, *terminal\_services\_port=None*, *high\_performance\_mouse=None*, *shared\_console\_enable=None*, *shared\_console\_port=None*, *remote\_console\_acquire=None*, *brownout\_recovery=None*, *ipmi\_dcmi\_over\_lan\_enabled=None*, *vsp\_log\_enable=None*, *vsp\_software\_flow\_control=None*)：修改ILO的全局设置,只有指定的值将被改变。

mod\_network\_settings(*enable\_nic=None*, *reg\_ddns\_server=None*, *ping\_gateway=None*, *dhcp\_domain\_name=None*, *speed\_autoselect=None*, *nic\_speed=None*, *full\_duplex=None*, *dhcp\_enable=None*, *ip\_address=None*, *subnet\_mask=None*, *gateway\_ip\_address=None*, *dns\_name=None*, *domain\_name=None*, *dhcp\_gateway=None*, *dhcp\_dns\_server=None*, *dhcp\_wins\_server=None*, *dhcp\_static\_route=None*, *reg\_wins\_server=None*, *prim\_dns\_server=None*, *sec\_dns\_server=None*, *ter\_dns\_server=None*, *prim\_wins\_server=None*, *sec\_wins\_server=None*, *static\_route\_1=None*, *static\_route\_2=None*, *static\_route\_3=None*, *dhcp\_sntp\_settings=None*, *sntp\_server1=None*, *sntp\_server2=None*, *timezone=None*, *enclosure\_ip\_enable=None*, *web\_agent\_ip\_address=None*, *shared\_network\_port=None*, *vlan\_enabled=None*, *vlan\_id=None*, *shared\_network\_port\_vlan=None*, *shared\_network\_port\_vlan\_id=None*, *ipv6\_address=None*, *ipv6\_static\_route\_1=None*, *ipv6\_static\_route2=None*, *ipv6\_static\_route\_3=None*, *ipv6\_prim\_dns\_server=None*, *ipv6\_sec\_dns\_server=None*, *ipv6\_ter\_dns\_server=None*, *ipv6\_default\_gateway=None*, *ipv6\_preferred\_protocol=None*, *ipv6\_addr\_autocfg=None*, *ipv6\_reg\_ddns\_server=None*, *dhcpv6\_dns\_server=None*, *dhcpv6\_rapid\_commit=None*, *dhcpv6\_stateful\_enable=None*, *dhcpv6\_stateless\_enable=None*, *dhcpv6\_sntp\_settings=None*)：为ILO卡配置网络

mod\_snmp\_im\_settings(*snmp\_access=None*, *web\_agent\_ip\_address=None*, *snmp\_address\_1=None*, *snmp\_address\_1\_rocommunity=None*, *snmp\_address\_1\_trapcommunity=None*, *snmp\_address\_2=None*, *snmp\_address\_2\_rocommunity=None*, *snmp\_address\_2\_trapcommunity=None*, *snmp\_address\_3=None*, *snmp\_address\_3\_rocommunity=None*, *snmp\_address\_3\_trapcommunity=None*, *snmp\_port=None*, *snmp\_trap\_port=None*, *snmp\_v3\_engine\_id=None*, *snmp\_passthrough\_status=None*, *trap\_source\_identifier=None*, *os\_traps=None*, *rib\_traps=None*, *cold\_start\_trap\_broadcast=None*, *snmp\_v1\_traps=None*, *cim\_security\_mask=None*, *snmp\_sys\_location=None*, *snmp\_sys\_contact=None*, *agentless\_management\_enable=None*, *snmp\_system\_role=None*, *snmp\_system\_role\_detail=None*)：SNMP和IMI设置

mod\_user(*user\_login*, *user\_name=None*, *password=None*, *admin\_priv=None*, *remote\_cons\_priv=None*, *reset\_server\_priv=None*, *virtual\_media\_priv=None*, *config\_ilo\_priv=None*)：为一个用户设置属性,只有指定的参数将被改变。所有的参数除了user\_name和密码都应该是布尔。

press\_pwr\_btn()：按一下电源按钮

profile\_apply\_get\_results()：恢复上一次属性修改

profile\_list()：列出所有属性配置

reset\_rib()：Reset the iLO/RILOE board （重置所有更改）

reset\_server()：重启服务器

set\_ahs\_status(*status*)：启用或禁用AHS日志

set\_asset\_tag(*asset\_tag*)：设置服务器资产标记

set\_ers\_irs\_connect(*ers\_destination\_url*, *ers\_destination\_port*)：连接到远程服务器？

set\_host\_power(*host\_power=True*)：开机或关机

set\_host\_power\_saver(*host\_power\_saver*)：配置功率调节器

set\_language(*lang\_id*)：设置默认语言。只有EN,JA和ZH的支持？

set\_one\_time\_boot(*device*)：设置一个时间启动设备,设备应该是正常的,软盘、光盘、硬盘驱动器、usb、rbsu或网络。国际劳工组织4还支持emb菜单(显示默认的启动菜单),emb ACU(靴子到ACU),EMB-HPSUM-AUTO(靴HPSUM在自动更新模式),EMB-DIAGS(发射洞察力诊断为Linux在交互模式)和RBSU(引导进入系统RBSU)

set\_pers\_mouse\_keyboard\_enabled(*enabled*)：启用/禁用持久的鼠标和键盘

set\_persistent\_boot(*devices*)：设定持续引导顺序,设备应该以逗号分隔

set\_power\_cap(*power\_cap*)：设置功率功能特定的值

set\_pwreg(*type*, *threshold=None*, *duration=None*):设置电源的报警阈值

set\_security\_msg(*security\_msg*, *security\_msg\_text=''*)：启用/禁用安全消息在ILO屏幕的显示并设置它的值

set\_server\_auto\_pwr(*setting*)：设置自动上电延时设置。有效的设置是错误的,真正的(最小延迟)、15、30、45 60(数量的延迟或随机(随机延迟高达60秒。)

set\_server\_name(*name*)：修改服务器的名称

set\_vf\_status(*boot\_option='boot\_once'*, *write\_protect=True*)：设置参数的RILOE虚拟软盘指定虚拟媒体。有效引导选项启动一次,引导总是,没有启动,连接和断开。

set\_vm\_status(*device='cdrom'*, *boot\_option='boot\_once'*, *write\_protect=True*)：设置参数指定的虚拟媒体。有效引导选项启动一次,引导总是,没有启动,连接和断开。有效的设备是软盘和光盘。

trigger\_l2\_collection(*message\_id*)：发起一个L2数据收集提交到远程服务器？

uid\_control(*uid='No'*)：把UID灯打开(“Yes”)或关闭(“No”)

update\_rib\_firmware(*filename*, *progress=None*)：上传新的肋固件,使用“最新”作为文件名自动下载并使用最新的固件。这个函数可能需要一段时间,你可以通过一个可调用进度通知在进步参数。这个调用将被称为与进展消息。这些消息不是从一个回车(\\ r”)和一个可选的ANSI的清晰的线的顺序(“\\\[K”),或没有一个。当打印到终端,附加一个换行符只有第二类型的字符串。当使用外部数据终端环境,确保你脱光回车和ansi序列

warm\_boot\_server()：热启动服务器

[set_vm_status]: http://seveas.github.io/python-hpilo/ilo.html#hpilo.Ilo.set_vm_status