getAdminLicense

Back to index

Summary

Retrieves the admin license, which can be used when all concurrent user licenses are in use.

Usage

Perl

$cmdr->getAdminLicense();

ectool

ectool getAdminLicense

Examples

Perl

$cmdr->getAdminLicense();

ectool

ectool getAdminLicense

Response examples

You can receive one or more responses, depending on how you are licensed and actual license usage at the time of your query. For example:

When the user does not have the necessary permission to use the Administrator license:

<error requestId="1"> <code>AccessDenied</code> <where></where> <message>Principal '\bob@example.com' does not have execute privileges on systemObject[name=licensing,id=10]</message> <details></details> </error>

When the user has permission to get/use the Administrator license, but already has a User license:

<result>User 'bob@example.com@192.168.17.217' already has an active license.</result>

When the user has permission to use/get the Administrator license, has no other license, and the Administrator license is not currently assigned:

<result>User 'bob@example.com@192.168.17.217' was given the admin license.</result>

When the user has permission to get/use the Administrator license, has no license, and the Administrator license is currently assigned to someone else:

<result>User 'joedoe@example.com@192.168.17.217' was given the admin license that previously belonged to 'bob@example.com@192.168.17.217'.</result>