Registration command of the Storage Authentication Information (Google Cloud Storage)

Parameter explanation

[COMMON-OPTIONS]

These options are common to all utilities.

-r, --replace

Replacement (optional)

This parameter overwrites the existing Storage Authentication Information.

If you try to overwrite the existing Storage Management Information without specifying this option, an error occurs.

Note

To overwrite the existing Storage Authentication Information, specify the value that is already set with the [AUTH-OPTIONS].

If the information that is already set is not specified again, it is overwritten with the value "Use the default value.".

-f, --force

Omission of confirmation (optional)

This parameter registers information without confirmation of the registered information.

When you specify the existing Storage Authentication Information, the information is overwritten even if you do not specify "-r" or "--replace".

When you omit it, a confirmation message is output before registration of the Storage Authentication Information.

Are you sure to register? [y/n]:

Input "y" or "Y" to register the Storage Authentication Information specified by the command.

Input other than "y" or "Y" ends in an error.

[REQUIRED]

These parameters cannot be omitted.

-t, --type auth

Type of information (mandatory)

auth:

Storage Authentication Information

--id ID

ID (mandatory)

This ID identifies the Storage Authentication Information.

Specify from 3 to 63 bytes of ASCII printable characters.

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

[AUTH-OPTIONS]

This option sets the Storage Authentication Information.

Note

If you specify "Enable service account (--enable-service-account)", you cannot specify "Google Application Credentials file (--app-credentials FILE)".

For details on the priority of use for the Google Application Credentials file authentication and "Enable service account", refer to Storage Authentication Information settings.

--app-credentials FILE

Google Application Credentials File (optional)

This parameter specifies the absolute path of the json file where the authentication information is recorded in order to connect to Google Cloud Platform.

Specify up to 255 bytes of ASCII printable characters.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information is used during transfer.

--enable-service-account

Enable service account (optional)

This parameter specifies whether to enable authentication with a service account attached to the Google Compute Engine (GCE) instance to connect to Google Cloud Storage.

When you specify this parameter, authentication with a service account is enabled. In this case, the authentication information for the service account attached to the Google Compute Engine (GCE) instance is used.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information is used during transfer.

= Remarks =

If HULFT and HULFT Cloud Storage Option have been installed in an environment other than Google Compute Engine (GCE), transfer results in an error if you enable the service account.

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.