Export command of management information (Amazon S3)

For Amazon S3, you can output some types of management information registered in the Cloud Storage DB to a specified file in JSON (JavaScript Object Notation) format.

Export command of management information

utls3infomanage export -t {snd|rcv|auth} -o FILE [SUB-COMMAND-OPTION]

Parameter explanation

[REQUIRED]

These parameters cannot be omitted.

export

Export (mandatory)

This parameter outputs the management information registered in the Cloud Storage DB to a specified file in JSON format.

-t, --type {snd|rcv|auth}

Type of management information (mandatory)

This parameter specifies the type of management information that you want to export.

snd:

Send Storage Management Information

rcv:

Receive Storage Management Information

auth:

Storage Authentication Information

-o, --output FILE

Output file (mandatory)

This parameter specifies a file in JSON format to which the management information registered in the Cloud Storage DB is output.

Specify a file name from 1 to 256 bytes.

For details on the output of management information, refer to Input and output files of the management information.

[SUB-COMMAND-OPTION]

These are options for exporting.

= Remarks =

If you specify both "--id ID" and "--default", the information specified by the ID and the default information are output.

--default

Output of default information (optional)

If you specify the Send Storage Management Information for the type of management information, the default information for the Send Storage Management Information is output.

If you specify the Receive Storage Management Information for the type of management information, the default information for the Receive Storage Management Information is output.

If you specify the Storage Authentication Information for the type of management information, the default information for the Storage Authentication Information is output.

--id ID

ID (optional)

This parameter specifies the ID of the Send Storage Management Information, the Receive Storage Management Information, or the Storage Authentication Information that you want to output.

To output information from the Send Storage Management Information, specify the Send Storage Management Information ID.

To output information from the Receive Storage Management Information, specify the Receive Storage Management Information ID.

To output information from the Storage Authentication Information, specify the Storage Authentication Information ID.

Specify an ID from 1 to 63 bytes of ASCII printable characters.

If you include single-byte spaces or "/", an error occurs.

= Remarks =

You can use "*" (asterisk) in an ID as a wild card.

The following example shows how to use a wild card:

Example)

To output the Send Storage Management Information with the ID represented by the regular expression "snd*" to the file "sample_output.json":

utls3infomanage export -t snd --id "snd*" --output sample_output.json

-i, --input FILE

Input file to append the exported information to (optional)

This parameter specifies a file in JSON format that contains management information.

If you specify an input file, the exported information is appended to the end of the file.

Specify a file name from 1 to 256 bytes.

Supplement

  • As shown below, you can specify either with a space or an equals sign (=) between the parameter and the setting value.

      --parameter Value 
      --parameter=Value

  • If you specify "-h" or "--help" for the parameter, the usage is output.