General usage
Options |
Description |
---|---|
-?, -h, --help |
Show help, default: false |
-s, --server |
URL of the server, for example, http://my_host_url:<port number other than default port 80 or 1080, 1080> |
Commands |
Description |
Parameters |
---|---|---|
anonymize |
Anonymizes the audit log files. This is compliant to GDPR. The General Data Protection Regulation (GDPR) protects individuals’ personal data within the European Union. It also regulates the export of personal data outside the EU. GDPR is a regulation by the European Parliament, the Council of the European Union, and the European Commission. |
Please note that you must wait at least 30 minutes after the deletion of the user from User Management before you can start the anonymization process. Usage: anonymize [options] Options: * -n, --name Name of the user or user group -p, --password Password of executor, default: superuser * -type, --type UUID type is user or user group -u, --user User name of the executor, default: superuser |
assignLicense |
Assigns a license to user. |
Usage: assignLicense [options] Options: -ag, --affectedGroup Name of affected user group, default: [] -au, --affectedUser User name of affected user, default: [] * -l, --license Product code, default: [] -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
assignPrivilege |
Assigns privileges |
Usage: assignPrivilege [options] Options: -ag, --affectedGroup Name of affected user group, default: [] -au, --affectedUser User name of affected user, default: [] -p, --password Password of the executor, default: superuser * -pr, --privilege Privilege, default: [] -u, --user User name of the executor, default: superuser |
assignUser |
Associates a user to a user group. |
Usage: assignUser [options] Options: * -ag, --affectedGroup Name of affected user group * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
changePassword |
Changes a password. |
Usage: changePassword [options] Options: * -ap, --affectedPassword Password of affected user * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
checkLicense |
Checks tenant license. |
Usage: checkLicense [options] Options: * -l, --license Product code, default: [] -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
createGroup |
Creates a user group. |
Usage: createGroup [options] Options: -ad, --affectedDescription Description of affected user group * -ag, --affectedGroup Name of affected user group -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
createMiningServer |
Creates ARIS Process Mining server application |
Usage: createMiningServer [options] Options: -aid, --applicationClientId Client ID of the affected application -asec, --applicationClientSecret Client secret of the affected application -as, --applicationScopes API scopes of the affected application -p, --password Password of editor Default: superuser -u, --user User name of editor Default: superuser |
createTenant |
Creates a new tenant. |
Usage: createTenant [options] Options: -u, --user User name of the executor, default: superuser -p, --password Password of the executor, default: superuser -t, --tenant <TENANTNAME> (mandatory) For tenant names please only use up to 25 lowercase ASCII characters and numbers. The name must begin with a character. Special characters, such as _ and characters, for example, in Chinese, Cyrillic or Arabic cannot be used. --arisservicePassword (-arisservicep) <PASSWORD> --superuserPassword (-superuserp) <PASSWORD> --systemPassword (-systemp) <PASSWORD> |
createUser |
Creates a new user. |
Usage: createUser [options] Options: -ad, --affectedDescription Description of affected user -ae, --affectedEmail E-mail address of affected user -af, --affectedFirstName First name of affected user -al, --affectedLastName Last name of affected user -ap, --affectedPassword Password of affected user * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
deleteGroup |
Deletes a user group. |
Usage: deleteGroup [options] Options: * -ag, --affectedGroup Name of affected user group -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
deleteLicense |
Deletes the licenses for a product. |
Usage: deleteLicense [options] Options: * -l, --license Product code -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
deleteTenant |
Deletes an existing tenant. |
Usage: deleteTenant [options] Options: * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
deleteUser |
Deletes an existing user. |
Usage: deleteUser [options] Options: --user (-u) <USERNAME> (mandatory) --password (-p) <PASSWORD> (mandatory) --tenant (-t) <TENANTNAME> (mandatory) --affectedUser (-au) <USERLOGIN> (mandatory) |
exportAuditLog Export |
Exports audit events |
Usage: exportAuditLog [options] Options: -ed, --endDate End date in format yyyy-MM-dd HH:mm:ss -ev, --eventTypes Comma-separated list of events Default: ALL -f, --file Name and location of the export file * -ff, --fileFormat Format of the file to be exported as CSV or JSON. If the format is not specified, events will be exported in CSV format. Default: CSV -p, --password Password of editor Default: superuser -sd, --startDate Start date in format yyyy-MM-dd HH:mm:ss -u, --user User name of editor Default: superuser |
exportConfig |
Exports configuration of tenant. |
Usage: exportConfig [options] Options: -f, --file Configuration file, default: umc.properties -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
getTenant |
Prints information about a tenant. |
Usage: getTenant [options] Options: -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
getUser |
Prints information about a user. |
Usage: getUser [options] Options: * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
importConfig |
Updates configuration of tenant. |
Usage: importConfig [options] Options: -f, --file Configuration file, default: umc.properties -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
importConfigFile |
Updates the tenant configuration file. |
Usage: importConfigFile [options] Options: -f, --file Configuration file -o, --option Configuration option -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
importLicense |
Imports license files for a tenant . |
Usage: importLicense [options] Options: -f, --file Lincense file, default: license.zip -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
listPrivileges |
Lists the privileges of the user mentioned in the command |
Usage: listPrivileges [options] Options: -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
listTenants |
Lists all existing tenants. |
Usage: listTenants [options] Options: -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
purgeAuditLogByUser |
Deletes all audit logs of a deleted user. |
Usage: purgeAuditLogByUser [options] Options: * -ed, --endDate End date in format (yyyy-MM-dd HH:mm:ss) -p, --password Password of the executor, default: superuser -sd, --startDate Start date in format (yyyy-MM-dd HH:mm:ss) u, --user User name of the executor, default: superuser |
saveApplication |
Registers an external application. |
Usage: saveApplication [options] Options: -aid, --applicationClientId Client ID of the affected application -asec, --applicationClientSecret Client secret of the affected application -ad, --applicationDescription Description of the affected application -an, --applicationName Application name of the affected application -as, --applicationScopes API scopes of the affected application -p, --password Password of editor Default: superuser -u, --user User name of editor Default: superuser |
unassignLicense |
Removes a license from user. |
Usage: unassignLicense [options] Options: -ag, --affectedGroup Name of affected user group -au, --affectedUser User name of affected user * -l, --license Product code -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
unassignPrivilege |
Removes the privilege assignment. |
Usage: unassignPrivilege [options] Options: -ag, --affectedGroup Name of affected user group -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser * -pr, --privilege Privilege -u, --user User name of the executor, default: superuser |
unassignUser |
Removes a user from a user group. |
Usage: unassignUser [options] Options: * -ag, --affectedGroup Name of affected user group * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
updateLicense |
Replaces the license file for a tenant. |
Usage: updateLicense [options] Options: -f, --file Lincense file, default: license.zip * -l, --license Product code, default: [] -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
updateUser |
Updates an existing user. |
Usage: updateUser [options] Options: -ad, --affectedDescription Description of affected user -ae, --affectedEmail E-mail address of affected user -af, --affectedFirstName First name of affected user -al, --affectedLastName Last name of affected user * -au, --affectedUser User name of affected user -p, --password Password of the executor, default: superuser -u, --user User name of the executor, default: superuser |
Examples
The following line creates a tenant with name test. Please pay attention to the order of parameters.
y-tenantmgmt.bat -s http://my_aris_host.com -t test createTenant -u system -p manager
The following line creates a new tenant with name test01, port used 81, and initial system user password abc. Please pay attention to the order of parameters.
y-tenantmgmt.bat -s http://my_aris_host.com:81 -t test01 createTenant -u system -p manager -systemp abc
The following line gets information of the default tenant.
y-tenantmgmt.bat -s http://my_aris_host.com -t default getTenant -u system -p manager
The following line updates the configuration of default tenant.
y-tenantmgmt.bat -s http://my_aris_host.com -t default importConfig -f sldapconfig.properties -u superuser -p superuser
The following line assigns a license configuration to the user my_user.
y-tenantmgmt.bat -s http://my_aris_host.com-t default -assignLicense au my_user -l YCZUS -u system -p manager