VMware Perl SDK指南：ESXi 5.1与vCenter Server 5.1编程详解

需积分: 10 188 浏览量更新于2024-07-22 收藏 1.06MB PDF 举报

"VMware Perl SDK指南深入解析了如何利用Perl进行VMware vSphere的编程。本指南适用于ESXi 5.1版本和vCenter Server 5.1，涵盖了这些产品的特定API和功能，旨在帮助开发者更好地与VMware环境集成。文档支持后续版本直至被新版本取代，用户可访问VMware官方网站（<http://www.vmware.com/support/>）获取最新技术和产品更新。该文档提供了详尽的编程指导，包括但不限于如何使用Perl API操作虚拟机、管理网络、存储以及监控vSphere环境。它强调了在Perl环境中通过vSphere SDK进行交互的最佳实践和代码示例，有助于开发者编写高效且兼容的脚本，实现自动化任务和管理任务的自动化。值得注意的是，VMware对所有产品享有全面的版权保护，并在<http://www.vmware.com/go/patents>列出相关的专利。此外，文档中还包含用户反馈提交的渠道，鼓励开发者在使用过程中提出建议或遇到的问题。在阅读此指南时，用户应了解VMware是一个注册商标，文档中提及的其他商标均为其各自公司的财产。对于Perl开发者而言，这份指南是理解和掌握VMware vSphere平台的关键资源，对于那些希望扩展Perl在虚拟化管理中的应用的人来说，它是不可或缺的技术参考文献。"

vSphere SDK for Perl Programming Guide

12 VMware, Inc.

vSphere SDK for Perl Programming Conventions

SeveralprogrammingconventionsaredifferentthanyoumightexpectbecausetheSDKinteractswithaserver

usingSOAP/WSDL.

 Booleandatatypes–SDKapplicationssendandreceiveBooleanvaluesasfollows:

 Input(sendingfromtheclientapplication):

 Output(receivingfromtheserver):

TomatchBooleanvaluesinafilter,usethestringstrueandfalse.See“CreatingandUsingFilters”on

page 33.

 Date/Time–TheserverreturnsaSOAPdateTimevalue.YoucanusetheDate::ParsePerlmoduleto

processtheseobjects.

ThevSphereSDKforPerlacceptsonlynativeSOAPdateTimevaluesusingstandarddatetimeformat

withorwithoutfractionalseconds,andwithorwithoutGMT(Z)timezone:

YYYY-MM-DDThh:mm:ssTZD,

forexample,1997-07-16T19:20:30+01:00

YYYY-MM-DDThh:mm:ss.sTZD,forexample,1997-07-16T19:20:30.45+01:00

TheSDKalwaysreturnsdateTimevaluesinthestandarddatetimeformat.

 SOAPerrormessage–Mostlikelyindicatesanerrorontheserver,notanerrorwiththecommunication

totheserver.

vSphere SDK for Perl Common Options

AnumberofoptionsareavailableforanyvSphereSDKforPerlscript.Mostoftheseoptionsallowyouto

specifythehostorhoststoconnectto.Mostoptionsrequireanoptionvalue.

perl <app_name>.pl --<option_name> <option_value>

Forexample,topoweronavirtualmachineusingthevmcontrol.plutilityapplication,youmustspecifythe

nameofthevirtualmachinetopoweron,asfollows:

perl vmcontrol.pl --server <myserver> --username <admin> --password <mypassword> --operation

poweron --vmname <virtual_machine_name>

Runanyapplicationorsamplewithoutanyoptionsorwith--helptoseeitsparametersandexecution

examples.Informationaboutcommonandscript‐specificoptionsisincluded.

false: Use0,ʹ0ʹ,orʹfalseʹ(capitalizationignored)

true: Use1,ʹ1ʹ,orʹtrueʹ(capitalizationignored)

false: Returnvalueis0

true: Returnvalueis1

MPORTANTIfthehostyouaretargetingisinlockdownmode,youcannotexecutePerlscriptsagainstthe

host.

VMware, Inc. 13

Chapter 1 Getting Started with vSphere SDK for Perl

Specifying Options

Youcanspecifythecommonoptionsinseveralways,discussedinthissection.

WhenyourunavSphereCLIcommand,authenticationhappensinthefollowingorderofprecedence:

Thisorderofprecedencealwaysapplies.Thatmeans,forexample,thatyoucannotoverrideanenvironment

variablesettinginaconfigurationfile.

Using a Session File

Thesave_session.plscriptintheapps/sessiondirectoryillustrateshowtocreateasessionfile.Youcan

modifythescriptandincludeitinyourownapplication,orcreateasessionfileusingthescriptonthe

commandline,andthenpassinthatsessionfilewhenrunningvSphereSDKforPerl

commands.See“Saving

Sessions”onpage 36.

Thesessionfiledoesnotrevealpasswordinformation.Ifasessionfileisnotusedfor30minutes,thesession

expires.

To create and use a session file

1 Connecttothedirectorywherethescriptislocated,forexample,onWindows:

cd C:\Program Files\VMware\VMware vSphere CLI\Perl\apps\session

2Runsave_session.pl.Youmustsupplyconnectionparametersandthenameofasessionfileinwhich

thescriptcansaveanauthenticationcookie.

perl save_session.pl --savesessionfile <location> --server <server>

Forexample:

perl save_session.pl --savesessionfile C:\Temp\my_session --server my_server

Ifyouspecifyaserverbutnousernameorpassword,thescriptpromptsyou.

3Youcannowrunscriptsinthe\appsor\samplesdirectoryoryourownscriptsandpassinthesession

fileusingthe--sessionfileparameterasfollows:

<command> --sessionfile <sessionfile_location> <command_options>

Forexample:

perl hostinfo.pl --sessionfile C:\Temp\my_session

Table 1-2. vSphere CLI Authentication Precedence

Authentication Description See

Commandline Password(--password),sessionfile

(--sessionfile),orconfigurationfile

(--config) specifiedonthecommandline.

“UsingaSessionFile”onpage 13

Configurationfile Passwordsspecifiedina.visdkrc

configurationfile.

“UsingaConfigurationFile”onpage 14

Environment

variable

Passwordspecifiedinanenvironment

variable.

“SettingEnvironmentVariables”onpage 14

Credentialstore Password

retrievedfromthecredentialstore. “CredentialStorePerlLibrary”onpage 61

Currentaccount

(ActiveDirectory)

Currentaccountinformationus edtoestablish

anSSPIconnection.Windowsonly.

.“UsingMicrosoftWindowsSecuritySupport

ProviderInterface(SSPI)”onpage 15

Prompttheuserfora

password.

NOTEIfyouuseasessionfile,anyotherconnectionparametersareignored.

vSphere SDK for Perl Programming Guide

14 VMware, Inc.

Youcanusethecodeinthe\apps\session\save_session.plutilityapplicationinsideyourownvSphere

SDKforPerlapplication.Ifacalltotheserverthrowsanexception,yourapplicationshouldterminatethe

sessiontoavoidsessionleaks.Youcoulddothiswithanerrorhandlerthatrunsdisconnect()orlogout(),

forexample:

eval {

# ... insert program here ...

};

if (@$) {

print "Fatal error: $@";

Util::disconnect();

exit(1);

}

Youcanalsousethe_END_pseudo‐signalhandlertoperformadisconnect,asfollows:

$SIG{__END__} = sub { Util::disconnect(); }

Passing Parameters at the Command Line

Passparametersatthecommandlineusingoptionnameandoptionvaluepairs(someoptionshavenovalue).

--<optionname> <optionvalue>

Thefollowingexampleconnectstotheserverasusersnow-whitewithpassworddwarf$.Thefirstexample

(Linux)usesanescapecharacterbeforeeachspecialcharacter,theotherexamplesusesinglequotes(Linux)

anddoublequotes(Windows).

Linux

vminfo.pl --server <server> --username snow\-white --password dwarf\$ --vmname <name>

vminfo.pl --server <server> --username ‘snow-white’ --password ‘dwarf$’ --vmname <name>

Windows

vminfo.pl --server <server> --username “snow-white” --password “dwarf$” --vmname <name>

Setting Environment Variables

YoucansetenvironmentvariablesinaLinuxprofile,intheEnvironmentpropertiesdialogboxofthe

MicrosoftWindowsSystemcontrolpanel,or,forthecurrentsession,atthecommandline.Environment

variablesarelistedwhenyourunacommandwith--help.

Thefollowingexampleshowsthecontentsofa

/root/.visdkrc filethatusesenvironmentvariables:

VI_SERVER = <server>

VI_USERNAME = <usr>

VI_PASSWORD = <root_password>

VI_PROTOCOL = https

VI_PORTNUMBER = 443

Donotescapespecialcharactersinthefilethatspecifiesenvironmentvariables.

Ifyouhavesetupyoursystemtorunthisfile,youcanrunscriptsonthespecifiedserverafterwards.

Using a Configuration File

Aconfigurationfileisatextfilethatcontainsvariablenamesandsettings.Variablescorrespondingtothe

connectionoptionsareshowninTable 1‐3.Use--configiftheconfigurationinformationissavedina

differentfilethan./visdkrc.Ifyouspecify--config,thesystemignoresthe./visdkrcsettings.

You

canusethe--configoptiontorunascriptwiththeconfigurationfile,forexample:

connect.pl --config <my_saved_config> --list

CAUTIONLimitreadaccesstoaconfigurationfile,especiallyifitcontainsusercredentials.

VMware, Inc. 15

Chapter 1 Getting Started with vSphere SDK for Perl

Usingaconfigurationfileisusefulforrepeatedlyenteringconnectiondetails.Ifyouhavemultiple

vCenter ServerorESX/ESXisystemsandyouadministereachsystemindividually,youcancreatemultiple

configurationfileswithdifferentnames.Whenyouwanttorunacommandorasetofcommandsonaserver,

youpass

inthe--configoptionwiththeappropriatefilenameatthecommandline.

Using Microsoft Windows Security Support Provider Interface (SSPI)

Youcanusethe--passthroughauthcommand‐lineargumenttologintoavCenterServersystem(vCenter

Serverversion2.5Update2orlater).Using--passthroughauthpassesthecredentialsoftheexecutinguser

totheserver.Iftheexecutinguserisknownbyboththemachinefromwhichyouaccessthe

vCenterServer

systemandthemachinerunningthevCenterServersystem,noadditionalauthenticationisrequired.

IfSDKcommandsandthevCenterServersystemrunonthesamemachine,alocalaccountfortheexecuting

userworks.Iftheyrunondifferentmachines,thentheexecutingusermusthavean

accountinadomain

trustedbybothmachines.

SSPIsupportsanumberofprotocols.Bydefault,itselectstheNegotiateprotocol,whichindicatesthatclient

andserverattempttofindamutuallysupportedprotocol.Alternatively,youcanuse

--passthroughauthpackagetospecifyanotherprotocolsupportedbySSPI.Kerberos,theWindows

standardfor

domain‐levelauthentication,iscommonlychosen.

IfthevCenterServersystemisconfiguredtoacceptonlyaspecificprotocol,specifyingtheprotocoltovSphere

SDKforPerlcommandswith --passthroughauthpackagemightberequiredforsuccessfulauthentication

totheserver.Ifyouuse--passthroughauth,youdonothavetospecifyauthentication

informationinany

otherway.Forexample,torunconnect.plontheserver,youcanusethefollowingcommandatthe

commandline.

<command> <login_params> --passthroughauth

SeetheMicrosoftWebsiteforadetaileddiscussionofSSPI.

ThefollowingexampleconnectstoaserverthathasbeensetuptouseSSPI.Whenyourunthecommand,the

systemcallsvminfo.plwiththe--vmnameoption.Thesystemdoesnotpromptforausernameandpassword

because

thecurrentuserisknowntotheserver.

vminfo.pl --server <vc_server> --passthroughauth --passthroughauthpackage “Kerberos”

--vihost my_esx --vmname <name>

Common Options Reference

Table 1‐3listsoptionsthatareavailableforallvSphereSDKforPerlscripts.Usetheparameteronthe

commandlineandthevariableortheparameterinconfigurationfiles.

OTEUsingSSPIissupportedonlywhenyouruncommandsfromWindows,anduseavCenterServer

systemasthetargetserver.

Table 1-3. Options Available for all vSphere SDK for Perl Scripts

Parameter and Environment

Variable Description

--config <config_file>

VI_CONFIG=<config_file>

UsesthevSphereSDKforPerlconfigurationfileatthespecifiedlocation.

Important:Youmustspecifyapaththatisreadablefromthecurrentdirectory.

--credstore <credstore>

VI_CREDSTORE

Nameofacredentialstorefile.Defaultsto

<HOME>/.vmware/credstore/vicredentials.xmlonLinuxand

<APPDATA>/VMware/credstore/vicredentials.xmlonWindows.Commands

forsettingupthecredentialstore

areincludedinthevSphereSDKforPerl,which

isinstalledwiththevSphereCLI.ThevSphereSDKforPerlProgrammingGuide

explainshowtousethecredentialstore.

--encoding <encoding>

VI_ENCODING=<encoding>

Specifiestheencodingtobeused.Oneofcp936(SimplifiedChinese),ISO-8859-1

(German),orShift_JIS(Japanese).

Youcanuse--encoding

tospecifytheencodingvSphereSDKforPerlshouldmap

towhenitisrunonaforeignlanguagesystem.

剩余71页未读，继续阅读

SimonWang211

粉丝: 0
资源: 2

VMware Perl SDK指南：ESXi 5.1与vCenter Server 5.1编程详解

vsphere_perl_sdk脚本使用说明

vmware vSphere web service SDK开发指南

在Zabbix服务器上安装VMware vSphere Perl SDK

VMware vSphere SDK编程指南

VSphere Perl SDK连接指南

VMWare VSphere 5.5 SDK整套文档（英文）

vsphere-automation-sdk-perl：[不建议使用]，请参阅自述文件。 使用VMware REST API的vSphere的Perl示例，语言绑定和API参考文档

VMware-vSphere-SDK-6.0.0

VMware-vSphere-SDK-6.0.0.zip

VMware VI和vSphere SDK开发指南

最新资源

vsphere-automation-sdk-perl：[不建议使用]，请参阅自述文件。使用VMware REST API的vSphere的Perl示例，语言绑定和API参考文档