MediaCentral | UX Administration Guide : User Management Utility Tools

User Management Utility Tools
 
The MediaCentral User Management Utility tools are programs that an administrator runs as root from a command line on the Linux server that is running the User Management service, avid-ums.
Special Characters
Be careful when using special characters in path names and when resetting the administrator password using this command line utility. Some characters will not be processed correctly.
If you need to use special characters such as "/[]:;|=,+*< > ? & or an empty space in a parameter, enclose the parameter in either single quotes (') or double quotes ("). For example, to produce para*meter, type "para*meter".
If you need to use quotes in a parameter, do the following:
To produce double quotes within double quotes, use a backslash as an escape character. For example, "para\"meter" results in para"meter.
To produce a single quote within single quotes, use single quotes and a backslash as an escape character. For example, 'para'\''meter' results in para'meter.
For quotes that do not match the enclosing quotes, do not use an escape character. For example, "para'meter" results in para'meter.
Commands
 
Utility Tool Command
Options
Description
avid-ums-reset-admin-password
NEW_PASSWORD
Resets the password for the default MediaCentral administrator account.
avid-ums-statistics
 
Returns MediaCentral User Management Service statistics.
avid-ums-create-role
ROLE_NAME
ROLE_DESCRIPTION
LICENSE
[LAYOUT1][LAYOUT2]...[OPTIONS]
-p, --admin-password <arg>
Creates a role and assigns licenses and layouts to the role. Specifying one or more layouts is optional.
avid-ums-backup
BACKUP_FILE [options]
-pp, --postgres-superuser-password <arg>
-pu, --postgres-superuser-name <arg>
Performs a backup of the UMS database to a file that can be restored later. This command can be used for manual backup or as part of an automated backup.
For instructions on backing up and restoring MediaCentral databases, see the MediaCentral Platform Services Installation and Configuration Guide.
avid-ums-restore
BACKUP_FILE [options]
-pp, --postgres-superuser-password <arg>
-pu, --postgres-superuser-name <arg>
Restores the UMS database from the supplied file. If a user database already exists, it will be replaced by the restored one.
For information on a specific command, type the following:
[root]# avid-ums-[UTILITY_TOOL_NAME]