LicensingSettings

LicensingSettings

is an option for RemoteBatchSubmit and related functions to configure licensing for remote kernels.

Details

  • LicensingSettings takes an association with the following keys:
  • "Entitlement"Automaticthe on-demand license entitlement to use
    "MathLMServer"(required)a MathLM server address
    "Method"Automaticthe form of product licensing to use
  • The value of the LicensingSettings option may also be a supported "Method" setting, such as "Method""OnDemand". In this case, the default value Automatic of the "Entitlement" setting is used.
  • The following settings are accepted for the "Method" key:
  • Automaticuse the default licensing method associated with the function
    Nonedo not automatically activate the remote kernel
    "MathLM"obtain a license from a MathLM server
    "OnDemand"use on-demand licensing via the Wolfram Cloud
  • With "Method""OnDemand", the "Entitlement" key determines the on-demand license entitlement to activate the remote kernel. The value of this key can be a LicenseEntitlementObject, an entitlement ID as a string, the symbol Automatic or an association containing entitlement settings.
  • If the "Entitlement" key is set to Automatic, a new entitlement with default settings is created using CreateLicenseEntitlement.
  • If the "Entitlement" key is set to an an association, a new entitlement with the provided settings is created using CreateLicenseEntitlement.
  • Wolfram Engine kernels activated using on-demand licensing communicate regularly with the Wolfram license server in order to monitor usage.
  • On-demand license usage is charged against the entitlement owner's Service Credits balance on a pay-as-you-go basis.
  • With "Method""MathLM", the remote kernel is configured to request a license from the server specified by the "MathLMServer" key. The value of this key can be a string of the form "host" or "host:port", or a list like {"host",port}. An IPAddress expression may be substituted for the hostname.
  • With "Method"None, the remote kernel is given no explicit licensing or activation configuration and will attempt to activate normally using a mathpass file or command-line arguments.

Examples

open allclose all

Basic Examples  (2)

Activate the kernel in a remote batch job using an automatically created on-demand license entitlement:

Activate the kernel in a remote batch job using an automatically created on-demand license entitlement with custom settings:

Scope  (3)

Create an on-demand license entitlement explicitly and use it to activate the kernel in a remote batch job:

Activate a kernel in a remote job using an existing entitlement specified by its ID:

Activate a kernel in a remote job using a MathLM server accessible from within the computation provider's network:

Wolfram Research (2020), LicensingSettings, Wolfram Language function, https://reference.wolfram.com/language/ref/LicensingSettings.html.

Text

Wolfram Research (2020), LicensingSettings, Wolfram Language function, https://reference.wolfram.com/language/ref/LicensingSettings.html.

BibTeX

@misc{reference.wolfram_2020_licensingsettings, author="Wolfram Research", title="{LicensingSettings}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/LicensingSettings.html}", note=[Accessed: 16-January-2021 ]}

BibLaTeX

@online{reference.wolfram_2020_licensingsettings, organization={Wolfram Research}, title={LicensingSettings}, year={2020}, url={https://reference.wolfram.com/language/ref/LicensingSettings.html}, note=[Accessed: 16-January-2021 ]}

CMS

Wolfram Language. 2020. "LicensingSettings." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/LicensingSettings.html.

APA

Wolfram Language. (2020). LicensingSettings. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/LicensingSettings.html