Manage users with the Wowza Streaming Engine CLI password tool

Learn how to use the Wowza Streaming Engine™ media server software CLI password tool. The CLI password tool enables you to add, update, and delete users in the admin.password file. It also includes functionality for encoding passwords using Bcrypt or digest hash functions.

Notes:
 

Launch the CLI password tool


  1. In a Command Prompt or Terminal window, change to the directory [install-dir]/bin.
  2. Type the following command:

    Windows:

    passwordtool.bat

    Linux and MacOS:

    passwordtool.sh

Examples


Add a user

passwordtool --file <inputFile> --addUser --userName <username> --password <password> --groups <groups> --passwordEncoding <passwordEncoding>

Options

Option Description
--file <inputFile>

The full path to the admin.password file.

Aliases: -f

--addUser Add a new user.
--userName <username> The name of the user to create.
--password <password> The password for the user.
--groups <groups>

Assign access permissions to the user.

This parameter is optional. If it's not included, the user is automatically assigned admin,advUser permissions.

Supported values: admin, admin,advUser, basic, basic,advUser

--passwordEncoding <passwordEncoding>

The password encoding format to use.

This parameter is optional. If it's not included, Wowza Streaming Engine defaults to the <PasswordEncodingScheme> specified in Server.xml.

Supported values: bcrypt, digest, cleartext

--realm <realm>

The authentication realm to use. Required for digest password encoding.

The default value (Wowza) is also the default realm for the REST API. For HTTP providers, the default realm is Wowza Media Systems.

Update a user

passwordtool --file <inputFile> --updateUser --userName <username> --password <password> --groups <groups> --passwordEncoding <passwordEncoding>

Options

Option Description
--file <inputFile>

The full path to the admin.password file.

Aliases: -f

--updateUser Update a user.
--userName <username> The name of the user to update.
--password <password> The password for the user.
--groups <groups>

Assign access permissions to the user.

This parameter is optional.

Supported values: admin, admin,advUser, basic, basic,advUser

--passwordEncoding <passwordEncoding>

The password encoding format to use.

This parameter is optional.

Supported values: bcrypt, digest, cleartext

--realm <realm>

The authentication realm to use. Required for digest password encoding.

The default value (Wowza) is also the default realm for the REST API. For HTTP providers, the default realm is Wowza Media Systems.

Delete a user

passwordtool --file <inputFile> --deleteUser --userName <username>

Options

Option Description
--file <inputFile>

The full path to the admin.password file.

Aliases: -f

--deleteUser Delete a user.
--userName <username> The name of the user to delete.

More resources