Parameters for y-tenantmgmt.bat/y-tenantmgmt.sh

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>

Commands

Description

Parameters

anonymize

Anonymizes the audit log files.

This is compliant to GDPR. The General Data Protection Regulation (GDPR) protects the rights of 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.

* -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.

-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

-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.

* -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.

* -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.

* -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.

-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

createTenant

Creates a new tenant.

-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.

-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.

* -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.

* -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.

* -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.

--user (-u) <USERNAME> (mandatory)

--password (-p) <PASSWORD> (mandatory)

--tenant (-t) <TENANTNAME> (mandatory)

--affectedUser (-au) <USERLOGIN> (mandatory)

exportConfig

Exports configuration of tenant.

-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.

-p, --password

Password of the executor, default: superuser

-u, --user

User name of the executor, default: superuser

getUser

Prints information about a 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

importConfig

 

Updates configuration of tenant.

-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.

-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 .

-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

-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.

-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.

* -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

unassignLicense

Removes a license from user.

-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.

-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

Remove a user from a user group.

* -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.

-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.

-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