doc-exports/docs/obs/tool-obsutil/obs_11_0001.html

<a name="obs_11_0001"></a><a name="obs_11_0001"></a>

<h1 class="topictitle1">obsutil Introduction</h1>
<div id="body1542943180895"><p id="obs_11_0001__p8060118">obsutil is a command line tool for accessing and managing OBS. You can use this tool to create buckets and upload, download, or delete files/folders. If you are familiar with the command line interface (CLI), obsutil is a good choice in batch processing and automatic tasks.</p>
<p id="obs_11_0001__p1135113471344">obsutil is compatible with Windows, Linux, and macOS. <a href="#obs_11_0001__table1282175018104">Table 1</a> lists the recommended operating system (OS) versions. </p>

<div class="tablenoborder"><a name="obs_11_0001__table1282175018104"></a><a name="table1282175018104"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0001__table1282175018104" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Recommended OS versions for obsutil</caption><thead align="left"><tr id="obs_11_0001__row1083550111016"><th align="left" class="cellrowborder" valign="top" width="22.97%" id="mcps1.3.3.2.3.1.1"><p id="obs_11_0001__p78385041015">OS</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="77.03%" id="mcps1.3.3.2.3.1.2"><p id="obs_11_0001__p14841250121019">Recommended Version</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0001__row17841250151013"><td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_11_0001__p984850121013">Windows</p>
</td>
<td class="cellrowborder" valign="top" width="77.03%" headers="mcps1.3.3.2.3.1.2 "><ul id="obs_11_0001__ul1569975214153"><li id="obs_11_0001__li1670045231516">Windows 7</li><li id="obs_11_0001__li155119411944">Windows 8</li><li id="obs_11_0001__li101943439412">Windows 10</li><li id="obs_11_0001__li1022510381598">Windows 11</li><li id="obs_11_0001__li6478105914155">Windows Server 2016</li><li id="obs_11_0001__li1640702155419">Windows Server 2019</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row13841150191018"><td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_11_0001__p88475041016">Linux</p>
</td>
<td class="cellrowborder" valign="top" width="77.03%" headers="mcps1.3.3.2.3.1.2 "><ul id="obs_11_0001__ul9872184517166"><li id="obs_11_0001__li118721445111610">SUSE 11</li><li id="obs_11_0001__li104009390915">EulerOS 2</li><li id="obs_11_0001__li49891744102816">CentOS 7</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row1384185091013"><td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_11_0001__p158410500108">macOS</p>
</td>
<td class="cellrowborder" valign="top" width="77.03%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_11_0001__p17842505108">macOS 10.13.4</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="obs_11_0001__section1963918332594"><h4 class="sectiontitle">Advantages</h4><p id="obs_11_0001__p894415449448">obsutil has the following advantages:</p>
<ol id="obs_11_0001__ol2088681194515"><li id="obs_11_0001__li7886211184519">Easy to use</li><li id="obs_11_0001__li16446102954513">Lightweight and installation-free</li><li id="obs_11_0001__li81671334175015">Compatible with Windows, Linux, and macOS</li><li id="obs_11_0001__li411611064613">Excellent performance and diversified configurations</li></ol>
</div>
<div class="section" id="obs_11_0001__section38975716584"><h4 class="sectiontitle">Application Scenarios</h4><ul id="obs_11_0001__ul170673213246"><li id="obs_11_0001__li470614326244">Automatic backup and archiving, for example, periodically uploading local data to OBS</li><li id="obs_11_0001__li635516119218">Operations that you cannot perform using other tools (like OBS Browser+). Such operations include synchronously uploading, downloading, and copying objects.</li></ul>
</div>
<div class="section" id="obs_11_0001__section3951253155910"><h4 class="sectiontitle">Functions</h4><p id="obs_11_0001__p20196241083"><a href="#obs_11_0001__table1233162315227">Table 2</a> lists the functions of obsutil.</p>

<div class="tablenoborder"><a name="obs_11_0001__table1233162315227"></a><a name="table1233162315227"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0001__table1233162315227" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Functions of obsutil</caption><thead align="left"><tr id="obs_11_0001__row034112362217"><th align="left" class="cellrowborder" valign="top" width="27.51%" id="mcps1.3.6.3.2.3.1.1"><p id="obs_11_0001__p1734192382220">Function</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72.49%" id="mcps1.3.6.3.2.3.1.2"><p id="obs_11_0001__p134162392219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0001__row1934162372212"><td class="cellrowborder" valign="top" width="27.51%" headers="mcps1.3.6.3.2.3.1.1 "><p id="obs_11_0001__p53462315226"><a href="obs_11_0007.html">Basic bucket management</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.49%" headers="mcps1.3.6.3.2.3.1.2 "><p id="obs_11_0001__p8529162815477">Allows you to:</p>
<ul id="obs_11_0001__ul3120154594714"><li id="obs_11_0001__li5120174584718">Create buckets of different storage classes in specific regions.</li><li id="obs_11_0001__li8120134534716">Delete buckets.</li><li id="obs_11_0001__li6120174574710">Get the bucket list or configuration information.</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row33415236221"><td class="cellrowborder" valign="top" width="27.51%" headers="mcps1.3.6.3.2.3.1.1 "><p id="obs_11_0001__p4341423112213"><a href="obs_11_0012.html">Basic object management</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.49%" headers="mcps1.3.6.3.2.3.1.2 "><p id="obs_11_0001__p15341923152219">Allows you to upload, download, delete, and list objects. In detail, you can:</p>
<ul id="obs_11_0001__ul12642182419529"><li id="obs_11_0001__li764212415211">Upload one or more files or folders.</li><li id="obs_11_0001__li1590173085414">Upload large files in multipart uploads.</li><li id="obs_11_0001__li2774134519212">Synchronously upload, download, and copy incremental objects.</li><li id="obs_11_0001__li1465273410116">Copy a single object or a batch of objects sharing the same prefix.</li><li id="obs_11_0001__li18481351155216">Move a single object or a batch of objects sharing the same prefix.</li><li id="obs_11_0001__li18561144325">Resume failed upload, download, or copy tasks.</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row181665745717"><td class="cellrowborder" valign="top" width="27.51%" headers="mcps1.3.6.3.2.3.1.1 "><p id="obs_11_0001__p13166074572"><a href="obs_11_0056.html">Logging</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.49%" headers="mcps1.3.6.3.2.3.1.2 "><p id="obs_11_0001__p616618717570">Provides logging on your client to record operations on buckets and objects for analysis.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_11_0001__section547113329618"><h4 class="sectiontitle">Command Line Structures</h4><p id="obs_11_0001__p236115413127">Below describes how to use commands in obsutil:</p>
<ul id="obs_11_0001__ul76317975017"><li id="obs_11_0001__li116359175019">In Windows<p id="obs_11_0001__p1790953211619"><a name="obs_11_0001__li116359175019"></a><a name="li116359175019"></a><strong id="obs_11_0001__b15672515141519">obsutil </strong><em id="obs_11_0001__i103686209158">command</em> <em id="obs_11_0001__i20561425151511">[parameters...]</em> <em id="obs_11_0001__i634062931511">[options...]</em></p>
</li><li id="obs_11_0001__li11399121645012">In Linux or macOS<p id="obs_11_0001__p2143927135012"><a name="obs_11_0001__li11399121645012"></a><a name="li11399121645012"></a><strong id="obs_11_0001__b12431423202411"><strong id="obs_11_0001__b9243142317241">./</strong>obsutil </strong><em id="obs_11_0001__i10743162417246">command [parameters...] [options...]</em></p>
</li></ul>
<div class="note" id="obs_11_0001__note243793631714"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_11_0001__ul1941842151711"><li id="obs_11_0001__li139411442151716"><em id="obs_11_0001__i5488114417405">command</em> indicates the command to execute, for example, <strong id="obs_11_0001__b1419719384206">ls</strong> or <strong id="obs_11_0001__b619911380202">cp</strong>.</li><li id="obs_11_0001__li3148110101815"><em id="obs_11_0001__i0884172519426">parameters</em> indicates mandatory parameters, for example, the bucket name during bucket creation.</li><li id="obs_11_0001__li10580165711819"><em id="obs_11_0001__i19267611164315">options</em> indicates optional parameters. They must start with a hyphen (-).</li><li id="obs_11_0001__li18236578264">Square brackets ([]) are not part of a command. Remove them before executing a specific command.</li><li id="obs_11_0001__li138084514549">You must escape special characters (including &amp; &lt; &gt; and spaces) in a command using quotation marks. Single quotation marks are for Linux or macOS, and double quotation marks for Windows.</li><li id="obs_11_0001__li1599012256714">You can pass additional parameters in the <strong id="obs_11_0001__b2035734912219">-</strong><em id="obs_11_0001__i876825022212">key</em><strong id="obs_11_0001__b1784219591225">=</strong><em id="obs_11_0001__i66911162317">value</em> or <strong id="obs_11_0001__b1927130112310">-</strong><em id="obs_11_0001__i13931830152311">key</em><strong id="obs_11_0001__b1113863692318"> </strong><em id="obs_11_0001__i1999553715238">value</em> format, for example, <strong id="obs_11_0001__b1079615911207">-acl=private</strong>, or <strong id="obs_11_0001__b15798195902013">-acl private</strong>. Both formats are the same. Choose one as you like.</li><li id="obs_11_0001__li1172724912524">In Windows, you can execute <strong id="obs_11_0001__b19656615163910">obsutil.exe</strong> to enter interactive mode. In this mode, you can run <em id="obs_11_0001__i127091507427">command [parameters...] [options...]</em> where <strong id="obs_11_0001__b20857143624016">obsutil</strong> is not needed. Below gives an example:<pre class="screen" id="obs_11_0001__screen1512410439281">Enter "exit" or "quit" to logout
Enter "help" or "help command" to show help docs
Input your command:
--&gt;<strong id="obs_11_0001__b1037101413017">ls -limit=3 -s</strong>
obs://bucket-001
obs://bucket-002
obs://bucket-003
Bucket number: 3

Input your command:
--&gt;</pre>
</li><li id="obs_11_0001__li19286114217412">If you log in to a remote macOS or Linux via SSH to use obsutil, set <strong id="obs_11_0001__b85548772416">TMOUT</strong> to <strong id="obs_11_0001__b19487833121311">0</strong> to prevent obsutil from logging out due to SSH timeout.</li></ul>
</div></div>
</div>
</div>