Skip to Content

4.5.4. Module commands

<< Prev   Next >>

4.5.4.1. acquire

The command generates a response file based on a previously generated request file using the Licensing Center's web service.

Command line: 
ring license acquire [--request <RequestFile>] [--response <ResponseFile>] [--conf-location] [--send-statistics <mode>]
A description of parameters:
  • request. A full name of the file with the request to the Licensing Center. If a parameter is not specified, then the content of the request file is expected from the standard input stream.
  • response. A full name of the file to which a response from the License Center will be posted. If a parameter is not specified, then the contents of the response file will be output to the standard output stream.
  • conf-location. Specifies a directory with conf.cfg configuration file. This file analyzes ExternalResourcesMode parameter, which selects the applied licensing centre address.

    If this parameter is blank or the specified directory does not contain conf.cfg file, the search for this file is performed in the following directories:

    • On Windows:
      • 32-bit application in the 64-bit OS: %PROGRAMFILES(x86)%\1cv8\conf.
      • Otherwise: %PROGRAMFILES%\1cv8\conf.
    • On Linux:
      • The ~/.1cv8/1C/1cv8/conf directory (~ is the home directory of the user on whose behalf the 1C:Enterprise server operates).
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

A Licensing Center's response

If successful, the utility returns 0. Otherwise, the return code is not 0 and an error message is generated in the standard output stream.

4.5.4.2. activate

License activation using a licensing center web service.

Command line: 
ring license activate --first-name <name> --middle-name <middle name> --last-name <last name> [--email <email>] --company <company> --country <country> --zip-code <zip code> [--region <region> --district <district>] --town <town> --street <street> --house <house> --building <building> --apartment <apartment> --serial <serial number> --pin <PIN> [--previous-pin <previous PIN>] [--path <path>] [--validate] [--conf-location <path>] [--send-statistics <mode>]
A description of parameters:
  • first-name. The first name of a licensee. This parameter is optional if company parameter is specified.
  • middle-name. The middle name of a licensee. This parameter is optional if company parameter is specified.
  • last-name. The last name of a licensee. This parameter is optional if company parameter is specified.
  • email. The email address of a licensee.
  • company. The company of a licensee. When specifying the parameters first-name, middle-name, last-name this parameter is optional. At least 5 characters are required, but there should not be more than 3 identical characters in a row.
  • country. Country of registration. Cannot be empty.
  • zip-code. Zip code. Cannot be empty.
  • region. Province/region/area.
  • district. District.
  • town. Town. Cannot be empty.
  • street. Street. Cannot be empty.
  • house. House number. When specifying the building or apartment parameters, this parameter is optional. Cannot be empty.
  • building. Building. When specifying the house or apartment parameters, this parameter is optional. Cannot be empty.
  • apartment. Apartment. When specifying the house or building parameters, this parameter is optional. Cannot be empty.
  • serial. Serial number of a software product.
  • pin. PIN used to activate the license.
  • The previous-pin. When re-activating a license, this parameter must contain the PIN that was used during the initial activation of license. Must not be equal to the value of pin.
  • path. Specifies a path to the license repository if it differs the default path.
  • validate. If specified, then the execution of a command will be completed with an error if an attempt to get any of the key parameters resulted in a runtime error. If a parameter is not specified, the occurrence of an error when receiving any key parameter will not prevent a license from its successful activation. However, the license fields corresponding to the parameters not received will be filled with empty values which will make it impossible to continue using the activated license.
  • conf-location. Specifies a directory with conf.cfg configuration file. This file analyzes ExternalResourcesMode parameter, which selects the applied licensing centre address.

    If this parameter is blank or the specified directory does not contain conf.cfg file, the search for this file is performed in the following directories:

    • On Windows:
      • 32-bit application in the 64-bit OS: %PROGRAMFILES(x86)%\1cv8\conf.
      • Otherwise: %PROGRAMFILES%\1cv8\conf.
    • On Linux:
      • The ~/.1cv8/1C/1cv8/conf directory (~ is the home directory of the user on whose behalf the 1C:Enterprise server operates).
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

Upon successful registration, server returns a license file, which is placed in the specified storage. When the identical data (including kit data) is re-entered on the same machine, a similar license file is generated.

If successful, the utility returns 0. Otherwise, the return code is not 0 and an error message is generated in the standard output stream.

See also:

  • conf.cfg file

4.5.4.3. generate

A command is intended to generate a license file based on data from a request to the Licensing Center and its (center) response.

Command line: 
ring license generate --license <LicenseFile> --request <RequestFile> --response <ResponseFile> [--send-statistics <mode>]
A description of parameters:
  • license. Full name of the file with a resulting license. If a parameter is not specified, then the contents of the file of the activated license is output to the standard output stream.
  • request. Full name of the file with the request to the Licensing Center.
  • response. Full name of the file to which a response from the License Center will be posted.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

A file with an activated license.

If successful, the utility returns 0. Otherwise, the return code is not 0 and an error message is generated in the standard output stream.

4.5.4.4. get

Obtains an activated license from a license repository and writes it to a file.

Command line: 
ring license get -name <name> [--license <FullName>] [--path <storage>] [--send-statistics <mode>]
A description of parameters:
  • name. Name of a license for which information is expected.
  • license. Full path to the file in which the received license will be written. If not specified, the contents of the license file is output to the standard output stream.
  • path. Specifies a path to the license repository if it differs the default path.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

Obtains an activated license from a repository and writes it to a file with the specified name.

If successful, the utility returns 0. Otherwise, the return code is different from 0.

4.5.4.5. info

Displays information about the specified license.

Command line: 
ring license info [--name <name>] [--path <path>] [--send-statistics <mode>]
A description of parameters:
  • name. Name of a license for which information is expected. If this parameter is absent, then the system expects from the standard input stream the contents (not the name!) of a file with the activated license.
  • path. Specifies a path to the license repository if it differs the default path.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

License information in the following format:

License file name:
Information about user:
Name:
Middle name:
Last name:
Email:
Company:
Country:
ZIP code:
City:
Street:
Building:
Product information:
Description:
Date of equipment:
Registration number:
Product code:
License type:
License binding type:
TechnicalInfo:
LicenseType:
LicenseAssociationType:
HardwareKeyAssociation:
LicenseGenerationDate:
ProductCode:
DistributionKitRegistrationNumber:

The current computer hardware is not validated to match the hardware used to activate a license.

The command result can be divided into two parts: human-readable information and computer-readable information. Human-readable information is located in the following sections: License file name, User details, and Product information. These sections display localized information so that it is comprehensible to people.

Computer-readable information is located in the TechnicalInfo section. This section is used for automated processing. Data in this section is presented as key-value pairs. Each pair is displayed in a separate line. A separator between a key and a value is a colon ":". All the information in the section is presented in English and contains the following parameters:

  • LicenseType. Types of licenses and bindings return as their IDs specified below:
    • ProfLicenseUpdate. A license is an update of the previously issued PROF-level licenses.
    • ClientLicense. A client license.
    • ServerLicenseFor32BitServer. A license for the 32-bit application server.
    • ServerLicenseFor64BitServer. A license for the 64-bit application server.
    • ServerLicenseWithLimitedNumberOfConcurrentSessions. A license for the application server with a limited number of concurrent sessions.
    • LicenseForDedicatedFunctionalityTesting. A license for feature testing.
    • CorporateLicense. A CORP-level license.
    • EntirePlatformFunctionality. A license allows you to use the entire platform functionality.
    • MoreThan500UsersInInfobase. A license allows an infobase to contain more than 500 active users.
    • MoreThan12CpuCores. A license allows the application server to use more than 12 processor cores.
  • LicenseAssociationType indicates what a software license is bound to:
    • HardwareProtectionKey. A license is bound to a HASP dongle.
    • Computer. A license is bound to the computer.

      If a license is bound to a HASP dongle, the displayed information contains the HardwareKeyAssociation parameter. The parameter contains description of a HASP dongle to which a license is bound.

  • LicenseGenerationDate. License binding date in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.
  • ProductCode. A code of a product to be licensed.
  • DistributionKitRegistrationNumber. A registration number of a product to be licensed.

4.5.4.6. list

The command is intended to display a list of licenses in the license repository.

Command line: 
ring license list [--path <path>] [--send-statistics <mode>]
A description of parameters:
  • path. Specifies a path to the license repository if it differs the default path.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

A list of the license names found.

4.5.4.7. prepare-request

If a software license cannot be activated using the web service of the licensing center, you can activate the license by sending an email to the licensing center. To do this, the prepare-request, acquire and generate commands are used in the specified order.

The prepare-request command prepares the file for transfer to the Licensing Center.

Command line: 
ring license prepare-request --first-name <first name> --middle-name <middle name> --last-name <last name> [--email <email>] --company <company> --country <country> --zip-code <zip code> [--region <region> --district <district>] --town <town> --street <street> --house <house> --building <building> --apartment <apartment> --serial <serial number> --pin <PIN> [--previous-pin <previous PIN> --request <file>] --validate [--send-statistics <mode>]
A description of parameters:
  • first-name. The first name of a licensee. This parameter is optional if company parameter is specified.
  • middle-name. The middle name of a licensee. This parameter is optional if company parameter is specified.
  • last-name. The last name of a licensee. This parameter is optional if company parameter is specified.
  • email. The email address of a licensee.
  • company. The company of a licensee. When specifying the parameters first-name, middle-name, last-name this parameter is optional. At least 5 characters are required, but there should not be more than 3 identical characters in a row.
  • country. Country of registration. Cannot be empty.
  • zip-code. Zip code. Cannot be empty.
  • region. Province/region/area.
  • district. District.
  • town. Town. Cannot be empty.
  • street. Street. Cannot be empty.
  • house. House number. When specifying the building or apartment parameters, this parameter is optional. Cannot be empty.
  • building. Building. When specifying the house or apartment parameters, this parameter is optional. Cannot be empty.
  • apartment. Apartment. When specifying the house or building parameters, this parameter is optional. Cannot be empty.
  • serial. Serial number of a software product.
  • pin. PIN used to activate the license.
  • The previous-pin. When re-activating a license, this parameter must contain the PIN that was used during the initial activation of license. Must not be equal to the value of pin.
  • The request. Specifies a full path to the file in which information will be placed for transmission to the Licensing Center. If not specified, then the request text to the Licensing Center will be output to the standard output stream.
  • validate. If specified, then the execution of a command will be completed with an error if an attempt to get any of the key parameters resulted in a runtime error. If a parameter is not specified, the occurrence of an error when receiving any key parameter will not prevent a license from its successful activation. However, the license fields corresponding to the parameters not received will be filled with empty values which will make it impossible to continue using the activated license.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

Content of the Licensing Center request file is generated and written to a file or standard output stream.

If successful, the utility returns 0. Otherwise, the return code is not 0 and an error message is generated in the standard output stream.

4.5.4.8. put

Places a selected file with the activated license into the specified license repository.

Command line: 
ring license put --license <FullName> [--path <storage>] [--send-statistics <mode>]
A description of parameters:
  • license. A full path to a file of the activated license that will be placed in the license repository.
  • path. Specifies a path to the license repository if it differs the default path.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

Places the specified file with the activated license in the specified (explicitly or implicitly) license repository.

If successful, the utility returns 0. Otherwise, the return code is different from 0.

4.5.4.9. remove

Removes a license from a license repository.

Command line: 
ring license remove -name <name> [--path <storage>] [--all] [--send-statistics <mode>]
A description of parameters:
  • name. Name of a license to be removed from a repository.
  • path. Specifies a path to the license repository if it differs the default path.
  • all. Delete all licenses with the given name in the repository.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

A license is removed from the license repository.

If successful, the utility returns 0. Otherwise, the return code is different from 0.

4.5.4.10. update

Updates (re-obtains) all licenses from the license storage. License update means re-obtaining a license in the licensing center with the same registration number, PIN, and key parameters. Files with activated software licenses that exist before the update are saved with the .oldlic extension for backup purposes.

Command line: 
ring license update --conf-location <ConfigurationFile> [--force <value>] [--path <storage>] [--validate] [--send-statistics <mode>]
A description of parameters:
  • conf-location. Platform configuration file location directory. Used to search for the conf.cfg configuration file, which analyzes the ExternalResourcesMode parameter. If the parameter is not specified or the conf.cfg file is missing in the specified directory, an attempt will be made to find the conf.cfg file in the following directories:
    • On Windows:
      • 32-bit application in the 64-bit OS: %PROGRAMFILES(x86)%\1cv8\conf.
      • Otherwise: %PROGRAMFILES%\1cv8\conf.
    • On Linux:
      • ~/.1cv8/1C/1cv8/conf (~ directory is user's home directory on behalf of whom the licensing utility is run).
  • force. Defines the behavior of the licensing utility if errors occurred during the license update. The parameter can take the following values:
    • true. The error is ignored and the file during the processing of which the error occurred is skipped. Processing continues.
    • false. File processing is interrupted, all licenses are restored from the backups (default value).
  • path. Specifies a path to the license repository if it differs the default path.
  • validate. Indicates whether to check the hardware data received from the system. The parameter can take values:
    • true. Check.
    • false. Do not check (default value).
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

All licenses in the license storage is updated.

If successful, the utility returns 0. Otherwise, the return code is different from 0.

4.5.4.11. validate

Checks whether the current computer hardware matches the hardware registered at the moment of license activation.

Command line: 
ring license validate [--name <name>] [--path <path>] [--send-statistics <mode>]
A description of parameters:
  • name. Name of a license for which information is expected. If this parameter is absent, then the system expects from the standard input stream the contents (not the name!) of a file with the activated license.
  • path. Specifies a path to the license repository if it differs the default path.
  • send-statistics. Sends statistical information to 1C:Remote service (pult.1c.com, port 443). <mode> parameter can have the following values:
Result:

Confirmation that the computer hardware matches the hardware registered at the moment of license activation, or a list of differences (if the hardware lists are different).

If successful, the utility returns 0. Otherwise, the return code is not 0 and an error message is generated in the standard output stream. Some situations are highlighted by special error codes:

  • 1. The computer parameters changed.
  • 2. An error in verifying the digital signature of a license.

4.5.4.12. Information for 1C:Remote Service

The following data is sent to 1C:Remote service:

  • Operating system: Windows or Linux.
  • OS full name.
  • Architecture of a computer running a utility.
  • Version of a licensing utility so started.
  • Architecture of a licensing utility so started.
  • Version of Java managing the said utility.
  • Name of a licensing utility command being executed.
  • UUID generated on the basis of the following data (hash in UUID format):
    • Computer MAC address
    • Utility version
    • Utility architecture
  • Data batch ID.
  • Computer UUID generated on the basis of server MAC address (hash in UUID format).
  • Command execution date and time.

<< Prev   Next >>

Icon/Social/001 Icon/Social/006 Icon/Social/005 Icon/Social/004 Icon/Social/002