Help Center> Object Storage Service> Tools Guide> obsutil> Auxiliary Commands> Viewing Command Help Information
View PDF

Viewing Command Help Information

Function

You can use this command to view the commands supported by obsutil or view the help information of a specific command.

Command Line Structure

  • In Windows 
    obsutil help [command]
  • In Linux or macOS 
    ./obsutil help [command]

Examples

  • Take the Windows OS as an example. Run the obsutil help mb command to view the help information about the command for creating a bucket. 
    obsutil help mb

Summary:
create a bucket with the specified parameters

Syntax:
  obsutil mb obs://bucket [-fs] [-az=xxx] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx]

Options:
  -fs
    create a bucket that supports POSIX

  -az=xxx
    the AZ of the bucket, possible values are [multi-az]

  -acl=xxx
    the ACL of the bucket, possible values are [private|public-read|public-read-write]

  -sc=xxx
    the default storage class of the bucket, possible values are: [standard|warm|cold]

  -location=xxx
    the region where the bucket is located

  -config=xxx
    the path to the custom config file when running this command

Parameter Description

Parameter

Optional or Mandatory

Description

command

Optional

Currently, the help documents of the following commands are available:
Parent topic: Auxiliary Commands