Skip to main content

vserver object-store-server user regenerate-keys

Contributors
Suggest changes

Regenerate keys for object store user

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver object-store-server user regenerate-keys command regenerates a new access-key and secret-key for an object store user. The user keys generated will be shown as part of the command response. Note that the secret-key is not retrievable and should be noted down. It will not be shown as part of the vserver object-store-server user show command. If the secret-key is lost, the user keys will need to be regenerated.

Parameters

-vserver <Vserver Name> - Vserver Name

This parameter specifies the name of the Vserver on which the keys should be generated for the object store user. The object store user must already exist.

-user <TextNoCase> - Object Store Server User Name

This parameter specifies the name of the object store user.

[-key-time-to-live {P[<integer>D]T[<integer>H][<integer>M][<integer>S] | P<integer>W}] - Time Period after Which User Keys Expire

This optional parameter specifies a time period after which the object store user keys expire and are no longer valid. If the value specified is zero, then the user keys will not expire.

[-access-key <text>] - Access Key for the Object Store User

This optional parameter specifies the access key for the object store user.

[-secret-key <text>] - Secret Key for the Object Store User

This optional parameter specifies the secret key for the object store user.

Examples

The following example regenerates the keys for object store user for Vserver vs1.

cluster1::> vserver object-store-server user regenerate-keys -vserver vs1 -user user1
                               Vserver: vs1
                                  User: user1
                            Access Key: DUMMY_ACCESS_KEY_123
                            Secret Key: dummy_secret_key_1234_abcd__lkfj
                               Warning: The secret key won't be displayed again. Save this key for future use.

The following example sets the new keys, that are passed from the input, for object store user for Vserver vs1.

cluster1::> vserver object-store-server user regenerate-keys -vserver vs1 -user user1 -access-key DUMMY_ACCESS_KEY_123 -secret-key dummy_secret_key_1234_abcd__lkfj
                               Vserver: vs1
                                  User: user1
                            Access Key: DUMMY_ACCESS_KEY_123
                            Secret Key: dummy_secret_key_1234_abcd__lkfj
                               Warning: The secret key won't be displayed again. Save this key for future use.