Connect to a license server |
connect|c server port [ -proxy | -p proxyHost proxyPort] [-restricted | -r] | server: license server host name port: administration port number -proxy|-p proxyHost proxyPort: proxy host name and proxy port number -restricted|-r: forces connection in restricted mode (replaces -readOnly which remains valid for backward compatibility reasons) |
Get current license server information | getServerInfo|gsi | |
Disconnect from connected license server | disconnect|disc|d | |
Get license server configuration (*) | getConfig|gc | |
Get license information | getLicenseInfo|gli [-superseded] [-csv] | -superseded: display superseded
licenses. -csv: format output as a .csv file.
|
Show current license usage | getLicenseUsage|glu [-feature feat] [-all|-short] [-csv] [-usedOnly|-uo] | -feature: display usage on specified feature -all: display detailed client usage (including casual license usage in minutes, last used date for automatic recycling purposes, etc.) and running processes -short: display global usage only -csv: format output as a .csv file. -usedOnly: lists only consumed licenses. Expiration Date is only displayed when
connected to a R2015x license server or a higher level.
The client process level (5 for V5 licensing client processes, and 6 for V6 and 3DEXPERIENCE) is also displayed.
|
Get license usage tracing flags (*) | getLicenseUsageTraces|dut | Get license usage tracing flags |
Activate/Deactivate license usage trace (*) | setLicenseUsageTraces|sut all|license1 license2 ... -trace|-t yes|no [-editorId|-e editor] | license1 license2 ...: licenses to manage usage tracing, or all to manage all licenses -trace yes|no: to activate or deactivate trace -editorID: editor |
Display logged server messages | showLog|sl [-from fromDate] [-to toDate] | -from: lower limit (default midnight) -to: upper limit (default now) Date format: YYYY/MM/DD [HH:MM:SS] |
Modify server configuration (*) | setConfig|sc [-licensingPort|-lp port] [-adminPort|-ap port] [-failoverPort|-fp port] [-password|-pwd] [-restrictedPassword|-rpwd] [-remoteAdmin|-ra none|restricted|full] [-failoverMode|-fm yes|no] [-clusterName1|-cn1 name] [-clusterName2|-cn2 name] [-clusterName3|-cn3 name] [-enableLicenseStats|-els yes|no] [-automaticRecycling|-ar yes|no] [-enableOffline|-eo yes|no] | -licensingPort: listening port for license client access -adminPort: listening port for administration usage -failoverPort: listening port for intra cluster communications -password: ask to be prompted to enable/disable password protection administration -restrictedPassword: ask to be prompted to enable/disable restricted mode password protection administration -remoteAdmin: disable administration from a remote machine or enable in full or restricted mode -failoverMode: change standalone/failover mode -clusterName1: host name of the first machine of the failover configuration -clusterName2: host name of the second machine of the failover configuration -clusterName3: host name of the third machine of the failover configuration -enableLicenseStats: activates statistics -automaticRecycling: activates automatic license recycling. -enableOffline: enable offline license extraction. |
Configure settings in managed licensing service mode | manageCustomerSettings|mcs [-enableOffline yes|no] [-enableAutoRecycling yes|no] [ -fullPassword] [ -restrictedPassword] | -enableOffline: enables offline licensing. -enableAutoRecycling: activates automatic license recycling. -fullPassword: ask to be prompted to change existing full administration password. -restrictedPassword: ask to be prompted to change existing restricted administration password. |
Modify cluster (*) | modifyCluster|mc [-repair|-r host] [-update|-u host] [-changeName|-cn host newHost] [-changeMachine|-cm host newHost] | -repair: repair server when license database is corrupted -update: update cluster when host computer id has changed -changeName: modify cluster when a host name has changed, computer id still the same -changeMachine: modify cluster when a machine has been replaced (computer id no longer available) |
Enroll license files (*) | enrollLicense|e -dir inputDir [-file file1 file2...] | -dir: input directory -file: input files or regular expression |
Delete expired licenses (*) | deleteExpiredLicenses|dxl | |
Delete superseded licenses (*) | deleteSupersededLicenses|dsl | Useless when connected to a license server on a level higher than or equal to R2016x. |
Create group of users to manage authorization lists | createUserGroup|cug groupName -users user1 user2 ... [-replace] | -users: list of users contained in that group -replace: replace existing group of users if any |
Create group of hosts to manage authorization lists | createHostGroup|chg groupName -hosts host1 host2 ... [-replace] | -hosts: list of hosts contained in that group -replace: replace existing group of hosts if any |
Create an authorization list | createAuthorizationList|cal name -type t -editorId id [-product prd
-model m [-licenseId id | -pricingStruct s | -customerCountry c | -customerSite c
| -customerId i]] [-users user1[,number,[rule]] ...] [-hosts host1[,number,[rule]]
...] [-usergroups usrgrp1[,number,[rule]] ...] [-hostgroups
hostgrp1[,number,[rule]] ...] [-ipranges ipr1[,number,[rule]] ...] [-iprangegroups
iprgrp1[,number,[rule]] ...] [-replace] |
-type: type of authorization list (ALLOW, DENY, RESERVE,
LIMIT or COMPOSITE)
-editorId: unique editor identifier
-product: feature name to manage (optional); when not used,
the rule is applied at the Editor level.
-model: model of the feature to manage (NamedUser,
ConcurrentUser, Token, Credit or Site)
-licenseId: licenseID number (optional)
-pricingStruct: pricing structure (optional)
-customerCountry: customer country (optional)
-customerSite: customer site (optional)
-customerId: customer ID number (optional)
-users: list of individual users with optional number of
licenses and rule if type is COMPOSITE
-hosts: list of individual hosts with optional number of
licenses and rule if type is COMPOSITE
-ipranges: list of IPRanges with optional number of licenses
and rule if type is COMPOSITE
-usergroups: list of groups of users with optional number of
licenses and rule if type is COMPOSITE
-hostgroups: list of groups of hosts with optional number of
licenses and rule if type is COMPOSITE
-iprangegroups: list of groups of IPRanges with optional
number of licenses and rule if type is COMPOSITE
-replace: replace existing list if any
|
Create offline extraction restrictions | createOfflineRestrictions|cor name -editorId id -product prd -model
m [-licenseId id] [-keyword kw] [-maxDuration n] [-replace] [-rule ALLOW|DENY
[-users user1 ...] [-usergroups usrgrp1 ...] [-hosts host1 ...] [-hostgroups
hostgrp1 ...] [-ipranges ipr1 ...] [-iprangegroups iprgrp1 ...]]
| -editorId: editor unique identifier -product: product name to manage
-model: model of product to manage
(NamedUser|ConcurrentUser|Token|Credit) -licenseId: license product number -keyword: keyword to be provided to extract offline license. -maxDuration: maximum duration of
extraction validity, between 0 and 30 days -replace: replace existing restriction name if any
At least option -keyword or -maxDuration must be
passed. -rule: specifies allow/deny restriction rules for User, Host, IPRange, User Group, Host Group or IPRange Group. |
Delete user | deleteUser|du userName | |
Delete host | deleteHost|dh hostName | |
Delete group of users | deleteUserGroup|dug groupName | |
Delete group of hosts | deleteHostGroup|dhg groupName | |
Delete an authorization list | deleteAuthorizationList|dal listname | listname: name of list |
Delete offline restrictions | deleteOfflineRestrictions|dor listname
| listname: name of list |
List users | listUsers|lu | |
List hosts | listHosts|lh | |
List groups of users | listUserGroups|lug | |
List groups of hosts | listHostGroups|lhg | |
Rename user group | renameUserGroupName|rug currentName newName | |
Rename host group | renameHostGroupName|rhg currentName newName | |
Rename authorization list | renameAuthorizationList|ral currentName newName | |
Rename offline restrictions | renameOfflineRestrictions|ror currentListName newListName | |
List all authorization lists | listAuthorizationLists|lal | |
List all offline restrictions (keywords, maximum durations and rules) | listOfflineRestrictions|lor
| |
Create IP range | createIPRange|cipr name -ip iprange [-replace] | -ip: internet address range, (firstIP-lastIP or CIDR notation) -replace: replace existing item if any Examples:
- cipr local1921680 -ip 192.168.0.1/24
-replace
- cipr localcomputer -ip 127.0.0.1/32
-replace
- cipr local10232 -ip 10.232.0.0-10.232.255.255
-replace
- cipr localipv6 -ip fd00::/10 -replace
|
Create IP range group | createIPRangeGroup|ciprg name -ip iprange1 iprange2 ... [-replace] | -ip: IPRanges -replace: replace existing item if any Example: ciprg localgroup -ip localcomputer local1921680 local10232 localipv6 -replace |
List all IPRanges | listIPRange|lipr | |
List all IPRange groups | listIPRangeGroup|liprg | |
Rename IPRange | renameIPRange|ripr currentName newName | |
Rename IPRange group | renameIPRangeGroup|riprg currentName newName | |
Delete IPRange | deleteIPRange|dipr name | |
Delete IPRange group | deleteIPRange|diprg name | |
Export authorizations to file in XML format | exportAuthorizations|ea -o file | -o file: path of XML file to generate |
Import authorizations from file in XML format | importAuthorizations|ia -f file [-clear] | -f file: path of XML file to read -clear: remove all existing authorizations. Note that all differences are automatically accepted: existing data is removed and the new data is added. |
Monitor license server (*) | monitor|mon [-dumpHeap|-dh] [-dumpThreads|-dt] [-outDir|-o dir] | -dumpHeap|-dh: obtain server heap dump -dumpThreads|-dt: obtain server threads status -outDir|-o dir: directory storing result of command (mandatory for -dumpHeap option) |
Display mail configuration | getMailConfig|gmc | |
Set mail configuration | setMailConfig|smc [-test|-t] [-smtp servername] [-from sender] [-to email1,email2,...] [-activate|-a event yes|no] [-parameter|-p event param value] [-subject|-s event "..."] [-body|-b event "..."] [-mailBodyFooter|-footer "..."] | -test|-t: test mail configuration -smtp servername (*): SMTP server name -from sender (*): sets the sender of the e-mails. It can be useful when certain security rules set
on the smtp server prevent the default sender name
value. The default value is %host%@noreply .
%host% is a placeholder matching the hostname of the license
server.
%host% is very useful in failover mode, to clearly identify
which member sends an e-mail. Note that this value cannot be set nor even
displayed using the GUI.
-to email1,email2,...: names of recipients separated by comma (,) -activate|-a event yes|no: activate or deactivate the event, where event can be: OnServerStart : when server startsOnServerStop : when server stops OnDiskShortage : with parameter Threshold in range 1 - 99OnMemberIsolated : with parameter Threshold in range 1 - 60OnLicenseSoonExpiring : when licenses expire, with parameter Threshold in range 1 - 30 (supported in managed licensing service mode)OnResetSettingsIsolated : (for use only in managed licensing service mode) which can be triggered when Dassault Systèmes resets the settings (if you forgot the password).
-parameter|-p event param value: value of the event parameter -subject|-s event "...": subject of the mail for the event -body|-b event "...": set the body header of the mail for the event -mailBodyFooter|-footer "...": body footer of all mails. For example, to send mail notifications 25 days before license
expiration, run the command: smc -activate OnLicenseSoonExpiring yes
-parameter OnLicenseSoonExpiring Threshold 25
|
Manage SSL certificate (*) | manageSSLCertificate|msc [-install -crt file_path_to_server.crt -key file_path_to_server.key] | [-uninstall] [-nofailover] | Replaces the default self-signed SSL certificate embedded in the license server by another one you provided. -install: installs the certificate on the license server and stores it in the repository folder. -crt: file path to certificate file (server.crt) -key: file path to RSA key (server.key) -uninstall: uninstall
certificate previously installed (and use the default self-signed
one) -nofailover: do not
propagate to both other failover members. This option is useful
when installing a certificate on a failover member and the
certificate is not a domain certificate. By default, the
certificate is sent to the three failover members. This command can be useful when security
rules prevent access to HTTPS servers with a self-signed SSL
certificate or a certificate whose duration is too long. It is your responsibility to
periodically renew the certificate installed on the license
server. If this SSL certificate expires, licensing clients
will refuse to connect to the license server and licenses will
not be granted.
To revert back to the default behavior (for example, use the default self-signed certificate), you must delete the previously imported certificate using the -uninstall option.
|
Manage license usage tracing related to users (*) | userTraceSetting|uts [-enable|-e user] [-disable|-d user] [-remove|-r user] [-clear|-c] | -enable|-e user: activate usage tracing for user -disable|-d user: disable usage tracing for the specified user -remove|-r user: remove tracing for the specified user -clear|-c user: remove all tracing for all users If no parameter is passed to the command, the list of user tracing settings is displayed. |
Stop license server (*) | stopServer|ss | |
Exit the license administration tool | quit|q|exit|x|bye | |
Display help information | help|h|? [command] | command: (optional) display help information relative to this command |