Configuring File Transfer User Accounts

To create a new File Transfer user account, enter the following CONFIG command:

solace(configure)# create username <name> password <password> file-transfer

To edit the properties for an existing File Transfer account, enter the following CONFIG command:

solace(configure)# username <name>

Where:

<name> is the user name assigned to the file transfer user account. A file transfer account user name can contain up to 32 alphanumeric characters, and must be unique among all created CLI and File Transfer user accounts.

<password> is the password assigned to the file transfer user account. An account password can contain up to 128 alphanumeric characters, and can be used with all created CLI and File Transfer user accounts. As a best practice, Solace recommends assigning unique passwords for each user account you create.

The no version of this command, no username, deletes the specified user account from the event broker.

An error message occurs if you attempt to log on to an event broker by SFTP or SCP with a user account name that has not been defined as a File Transfer user through the username Global CONFIG command.

  • File Transfer user accounts do not have an access level associated with them. All File Transfer users can read, write, and delete files from the file system available to File Transfer users.
  • When the Config-Sync facility is used for event brokers that are in redundant pairs and/or event brokers that are being replicated, by default any configuration you make through a username CONFIG command is also made to its redundant mate and/or replication mate. If you do not want these changes to be synchronized, you can disable the synchronization of username CONFIG commands. Refer to Enabling Config-Sync.

Changing File Transfer User Passwords

To change the password for an existing File Transfer user account, enter the following CONFIG commands:

solace(configure)# username <name>
solace(configure/username)# change-password <password>

Where:

<name> is the user name assigned to the file transfer user account.

<password> is the password assigned to the File Transfer user account. An account password can contain up to 128 alphanumeric characters, and it can be used with all created CLI and File Transfer user accounts.

Renaming File Transfer Users

To change an existing File Transfer user account name, enter the following CONFIG command:

solace(configure/username)# rename <name>

Where:

<name> is the name of the File Transfer user account. A user account name can contain up to 32 alphanumeric characters, and it must be unique among all created user accounts, whether CLI or File Transfer.

Recovering Lost Passwords

Contact Solace for technical support to recover lost passwords from Solace PubSub+ event brokers.