python-saharaclient-doc 1.5.0-0ubuntu1 / usr / share / doc / python-saharaclient-doc / html / searchindex.js

Search.setIndex({docnames:["cli/index","cli/intro","cli/reference","contributor/index","index","reference/index","reference/pythonclient","reference/pythonclient_v2"],envversion:52,filenames:["cli/index.rst","cli/intro.rst","cli/reference.rst","contributor/index.rst","index.rst","reference/index.rst","reference/pythonclient.rst","reference/pythonclient_v2.rst"],objects:{"saharaclient.api.client":{Client:[6,0,1,""]},"saharaclient.api.cluster_templates":{ClusterTemplateManagerV1:[6,0,1,""],ClusterTemplateManagerV2:[7,0,1,""]},"saharaclient.api.cluster_templates.ClusterTemplateManagerV1":{"delete":[6,1,1,""],"export":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.cluster_templates.ClusterTemplateManagerV2":{"delete":[7,1,1,""],"export":[7,1,1,""],create:[7,1,1,""],get:[7,1,1,""],list:[7,1,1,""],update:[7,1,1,""]},"saharaclient.api.clusters":{ClusterManagerV1:[6,0,1,""],ClusterManagerV2:[7,0,1,""]},"saharaclient.api.clusters.ClusterManagerV1":{"delete":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],list:[6,1,1,""],scale:[6,1,1,""],update:[6,1,1,""],verification_update:[6,1,1,""]},"saharaclient.api.clusters.ClusterManagerV2":{"delete":[7,1,1,""],create:[7,1,1,""],force_delete:[7,1,1,""],get:[7,1,1,""],list:[7,1,1,""],scale:[7,1,1,""],update:[7,1,1,""],verification_update:[7,1,1,""]},"saharaclient.api.data_sources":{DataSourceManagerV1:[6,0,1,""],DataSourceManagerV2:[7,0,1,""]},"saharaclient.api.data_sources.DataSourceManagerV1":{"delete":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.data_sources.DataSourceManagerV2":{"delete":[7,1,1,""],create:[7,1,1,""],get:[7,1,1,""],list:[7,1,1,""],update:[7,1,1,""]},"saharaclient.api.images":{ImageManagerV1:[6,0,1,""],ImageManagerV2:[7,0,1,""]},"saharaclient.api.images.ImageManagerV1":{get:[6,1,1,""],list:[6,1,1,""],unregister_image:[6,1,1,""],update_image:[6,1,1,""],update_tags:[6,1,1,""]},"saharaclient.api.images.ImageManagerV2":{get:[7,1,1,""],list:[7,1,1,""],unregister_image:[7,1,1,""],update_image:[7,1,1,""]},"saharaclient.api.job_binaries":{JobBinariesManagerV1:[6,0,1,""],JobBinariesManagerV2:[7,0,1,""]},"saharaclient.api.job_binaries.JobBinariesManagerV1":{"delete":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],get_file:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.job_binaries.JobBinariesManagerV2":{"delete":[7,1,1,""],create:[7,1,1,""],get:[7,1,1,""],get_file:[7,1,1,""],list:[7,1,1,""],update:[7,1,1,""]},"saharaclient.api.job_binary_internals":{JobBinaryInternalsManager:[6,0,1,""]},"saharaclient.api.job_binary_internals.JobBinaryInternalsManager":{create:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.job_executions":{JobExecutionsManager:[6,0,1,""]},"saharaclient.api.job_executions.JobExecutionsManager":{"delete":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.job_types":{JobTypesManager:[6,0,1,""]},"saharaclient.api.job_types.JobTypesManager":{list:[6,1,1,""]},"saharaclient.api.jobs":{JobsManagerV1:[6,0,1,""]},"saharaclient.api.jobs.JobsManagerV1":{"delete":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],get_configs:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.node_group_templates":{NodeGroupTemplateManagerV1:[6,0,1,""],NodeGroupTemplateManagerV2:[7,0,1,""]},"saharaclient.api.node_group_templates.NodeGroupTemplateManagerV1":{"delete":[6,1,1,""],"export":[6,1,1,""],create:[6,1,1,""],get:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.node_group_templates.NodeGroupTemplateManagerV2":{"delete":[7,1,1,""],"export":[7,1,1,""],create:[7,1,1,""],get:[7,1,1,""],list:[7,1,1,""],update:[7,1,1,""]},"saharaclient.api.plugins":{PluginManagerV1:[6,0,1,""],PluginManagerV2:[7,0,1,""]},"saharaclient.api.plugins.PluginManagerV1":{convert_to_cluster_template:[6,1,1,""],get:[6,1,1,""],get_version_details:[6,1,1,""],list:[6,1,1,""],update:[6,1,1,""]},"saharaclient.api.plugins.PluginManagerV2":{get:[7,1,1,""],get_version_details:[7,1,1,""],list:[7,1,1,""],update:[7,1,1,""]},"saharaclient.api.v2.job_templates":{JobTemplatesManagerV2:[7,0,1,""]},"saharaclient.api.v2.job_templates.JobTemplatesManagerV2":{"delete":[7,1,1,""],create:[7,1,1,""],get:[7,1,1,""],get_configs:[7,1,1,""],list:[7,1,1,""],update:[7,1,1,""]},"saharaclient.api.v2.jobs":{JobsManagerV2:[7,0,1,""]},"saharaclient.api.v2.jobs.JobsManagerV2":{"delete":[7,1,1,""],create:[7,1,1,""],get:[7,1,1,""],list:[7,1,1,""],refresh_status:[7,1,1,""],update:[7,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"class":[6,7],"default":[2,6],"export":[1,2,6,7],"float":2,"import":[2,6],"long":2,"new":[2,6,7],"public":2,"return":[6,7],"transient":2,"true":2,For:[1,6],IDs:2,The:[1,2,6,7],There:[4,6,7],Using:6,VMs:2,abil:[1,2],about:[1,2,6,7],abov:6,acc:2,access:2,accesskei:[2,6,7],account:2,add:[2,6,7],add_node_group:[6,7],added:2,addit:2,addition:1,address:2,affin:2,after:2,all:[1,2,6],also:[2,7],alwai:2,anti:2,anti_affin:[6,7],api:[1,6,7],api_kei:6,apiv2:[4,5],arg:2,argument:[1,2,6,7],assign:6,attach:2,auth:[1,6],auth_url:6,authent:[1,7],auto:2,auto_security_group:[6,7],autoconfig:2,automat:2,avail:2,availability_zon:[6,7],avoid:6,binari:0,both:6,brief:2,bug:3,cacert:6,call:6,can:[1,2,6,7],catalog:6,chang:[6,7],choic:2,cli:[1,4],client:[4,5],cliff_fit_width:2,cliff_max_term_width:2,cloud:4,cluster:0,cluster_config:[6,7],cluster_id:[6,7],cluster_templ:[2,6,7],cluster_template_id:[6,7],clustermanagerv1:6,clustermanagerv2:7,clustertemplatemanagerv1:6,clustertemplatemanagerv2:7,code:3,column:2,combin:2,command:[1,2,4],commonli:1,commun:[3,6],complet:2,concept:4,config:[2,6,7],configur:[0,2,6],constructor:6,contain:[2,6,7],content:4,contribut:4,convert:6,convert_to_cluster_templ:6,correspond:6,count:[2,6,7],creat:[2,6,7],creation:2,credenti:[4,6,7],credential_pass:[6,7],credential_us:[6,7],csv:2,current:[2,6],data:[0,1,4],data_sourc:[2,6,7],data_source_id:[6,7],data_source_typ:[6,7],dataprocess:[1,2],datasourcemanagerv1:6,datasourcemanagerv2:7,default_image_id:[2,6,7],delet:[2,6,7],deploy:2,deprec:6,desc:[6,7],describ:[1,6,7],descript:[2,6,7],destin:2,detail:[1,2,6,7],determin:6,dict:[6,7],dictionari:2,direct:6,directli:6,directori:2,disabl:2,displai:2,doc:[1,4],document:[1,3],domain:2,domain_nam:[6,7],done:2,download:[2,6,7],dump:2,each:[2,4,6],edp:6,empti:2,enabl:[2,6],endpoint:[2,7],endpoint_typ:6,enough:6,entir:4,environ:[1,2],error:2,etc:6,event:2,everi:2,exampl:[6,7],except:2,execut:2,exist:[2,6,7],experiment:7,express:2,extra:[6,7],fail:2,fals:[2,6,7],featur:1,field:[2,6,7],file:2,filecont:6,filenam:2,find:6,first:2,fit:2,fix:2,flavor:2,flavor_id:[2,6,7],floating_ip_pool:[2,6,7],follow:[1,2,6,7],forc:7,force_delet:7,form:1,format:2,from:[2,6,7],full:2,gatewai:2,gerrit:3,get:[1,2,4,6,7],get_config:[6,7],get_fil:[6,7],get_version_detail:[6,7],greater:2,group:0,guid:4,hadoop_vers:6,happen:3,has:[3,6],have:[2,6],hdf:2,health:2,help:1,hint:[6,7],hive:2,host:2,how:3,html:1,http:1,idea:4,ident:[1,6],ies:2,ignor:2,imag:0,image_id:[2,6,7],imagemanagerv1:6,imagemanagerv2:7,implement:4,impli:2,includ:2,indent:2,indic:2,info:[6,7],inform:[1,2,3,6,7],input:2,input_auth_token:6,input_id:[6,7],insecur:6,instal:4,instanc:[2,6,7],instance_id1:7,instance_id2:7,instances_count:2,instanti:5,integ:2,interact:2,interfac:[2,6,7],intern:2,internalurl:6,introduct:[0,4],is_protect:[6,7],is_proxy_gatewai:[6,7],is_publ:[6,7],is_transi:[6,7],its:3,java:2,job:0,job_binari:[2,6,7],job_binary_id:[6,7],job_binary_intern:6,job_execut:6,job_id:[6,7],job_templ:[2,7],job_template_id:7,job_typ:[2,6,7],jobbinariesmanagerv1:6,jobbinariesmanagerv2:7,jobbinaryinternalsmanag:6,jobexecutionsmanag:6,jobsmanagerv1:6,jobsmanagerv2:7,jobtemplatesmanagerv2:7,jobtypesmanag:[6,7],json:2,kei:[2,6,7],keypair:2,keyston:6,keystoneauth1:6,keyword:[6,7],kill:2,kwarg:6,latest:1,launch:[2,6,7],launchpad:3,least:4,lib:[2,6,7],librari:4,like:[3,6],limit:[6,7],line:[1,4],list:[1,2,6,7],local:2,locat:6,log:2,mai:[4,6],main:[2,6,7],make:[2,4],manag:5,mandatori:6,manila:2,mapreduc:2,maprf:2,marker:[6,7],match:2,max:2,maximum:2,mechan:6,minim:2,minimum:6,miss:6,modul:4,more:[1,3,4,6],most:[1,6],mount:2,name:[1,2,6,7],need:[4,6,7],net_id:[6,7],network:2,neutron:2,new_ng:[6,7],new_tag:6,ng_template_id:[6,7],ngt_id:[6,7],node:0,node_config:[6,7],node_group:[6,7],node_group_templ:[2,6,7],node_group_template_id:[6,7],node_process:[6,7],nodegrouptemplatemanagerv1:6,nodegrouptemplatemanagerv2:7,noindent:2,non:[2,6],none:[2,6,7],nonnumer:2,notupd:[6,7],now:1,number:[2,6,7],obj_id:[6,7],object:[2,5],ofinst:2,old_ng:[6,7],one:2,ones:2,onli:2,openstack:[1,3],openstackcli:[1,4],oper:5,option:[1,2,7],order:4,org:1,os_auth_url:1,os_data_processing_url:1,os_password:1,os_project_nam:1,os_usernam:1,other:[2,3],output:2,output_id:[6,7],overview:[4,5],page:3,param:2,paramet:[1,2,6,7],part:[1,3],particip:3,pass:6,password:[1,2,6,7],pend:2,per:2,perform:6,physic:2,pig:2,pleas:3,plugin:[0,4],plugin_nam:[6,7],plugin_vers:[2,7],pluginmanagerv1:6,pluginmanagerv2:7,point:[2,6],pool:2,posit:2,possibl:[1,2],preced:2,prefix:2,print:2,prioriti:2,privat:2,privileg:2,process:[1,2,4,6],progress:2,project:[1,2,3],project_id:6,project_nam:6,prompt:2,protect:2,provid:[1,2,6],proxi:2,publicurl:6,purpos:6,pyleu:2,python:[1,2,3,5],quot:2,raw:6,read:4,refer:[0,1,3,4,6],refresh:7,refresh_statu:7,regex:2,region_nam:6,regist:[2,6,7],regul:2,regular:2,remov:[2,6,7],repeat:2,replac:[2,6],report:3,represent:2,requir:2,reset:2,resize_node_group:[6,7],rest:6,result:[6,7],retriev:6,revers:[6,7],rule:6,run:[1,2],sahara:[1,2,3,5],sahara_url:6,saharacli:[2,3,4,6,7],same:2,scale:[2,6,7],scale_object:[6,7],script:6,search:6,search_opt:[6,7],secret:2,secretkei:[2,6,7],section:3,secur:2,security_group:[2,6,7],see:6,sens:4,separ:3,servic:[6,7],service_typ:6,ses:6,session:6,set:2,share:[2,6,7],shell:[1,2],should:[2,3,4,6,7],show:2,show_progress:[6,7],size:2,some:[6,7],sort:2,sort_bi:[6,7],sort_column:2,sourc:0,spark:2,specif:2,specifi:[2,6,7],specifii:7,start:[2,6,7],statu:[2,6,7],stdout:2,store:2,storm:2,str:6,stream:2,submit:6,substr:2,succeed:2,support:[2,5],swift:[2,6,7],tabl:2,tag:[2,6],take:[1,2],taken:2,takeninto:2,templat:0,template_nam:6,tenant:[2,6],tenant_nam:6,text:6,than:2,them:2,thi:[2,4,6],through:3,two:6,type:0,understand:4,unprotect:2,unregist:2,unregister_imag:[6,7],updat:[2,6,7],update_data:[6,7],update_imag:[6,7],update_tag:6,url:[1,2,6,7],usag:2,use:[2,4,6],use_autoconfig:[6,7],use_design:2,used:[1,2,3,6,7],user:[2,6,7],user_keypair_id:[6,7],user_nam:[6,7],usernam:[1,2,6],using:[1,6],util:[1,4],valu:[2,6,7],variabl:[1,2],verif:[2,6,7],verification_upd:[6,7],version:[2,6,7],via:1,visibl:2,volum:2,volume_local_to_inst:[6,7],volume_mount_prefix:[6,7],volume_typ:[6,7],volumes_availability_zon:[6,7],volumes_per_nod:[6,7],volumes_s:[6,7],wait:2,want:4,when:2,where:2,whether:2,which:[1,3,7],width:2,yaml:2,you:[1,2,4],zero:2,zone:2},titles:["Sahara CLI client","Introduction","CLI Reference","Contributing","Python bindings to the OpenStack Sahara API","Reference guide","Python Sahara client","Python Sahara client for APIv2"],titleterms:{api:4,apiv2:7,authent:6,binari:[2,6,7],bind:4,check:6,cli:[0,2],client:[0,6,7],cluster:[2,6,7],configur:1,contribut:3,data:[2,6,7],discoveri:6,endpoint:6,execut:6,group:[2,6,7],guid:5,imag:[2,6,7],instanti:6,intern:6,introduct:1,job:[2,6,7],manag:6,node:[2,6,7],object:6,openstack:4,oper:[6,7],ops:[6,7],overview:[6,7],plugin:[2,6,7],python:[4,6,7],refer:[2,5],registri:[6,7],sahara:[0,4,6,7],sourc:[2,6,7],support:[6,7],templat:[2,6,7],type:[2,6,7]}})