Update a Client Identity
This topic provides an example of the XML to use with the AdminApi.adminSet method to update a client identity.
Method: sntl_admin_set (context, action, &return_status)
action (request)
action update
<?xml version="1.0" encoding="UTF-8"?>
<admin>
<cloud_licensing>
<update>
<identity>
<element identity_code="I4H6DUJ"/>
<element identity_status="disabled"/>
<element issued_to="demo"/>
<element allow_remote_login_access="1"/>
<element allow_remote_detach_access="1"/>
<element allow_network_detach_access="1"/>
<element limit_to="663955188930016042"/>
<element maximum_number_of_auto_registered_machines="3"/>
<element expiration_date="1638236850"/>
</identity>
</update>
</cloud_licensing>
</admin>
Use the identity_code element to indicate the client identity to be updated. This element is mandatory.
Use one or more of the following elements to update the value for these elements:
issued_to
|
Name of the person or entity to receive the identity string. |
identity_status
|
Change the status of the client identity. Possible values are: >"disabled" – The client identity should be disabled. >"enabled" – The disabled client identity should be re-enabled. |
allow_remote_login_access
|
Specify "1" or "0" to indicate whether a remote machine with the identity string should be allowed to or blocked from consuming a license from the license server machine. |
allow_remote_detach_access
|
Specify "1" or "0" to indicate whether a remote machine with the identity string should be allowed to or blocked from detaching a license from the license server machine. |
allow_network_detach_access
|
Specify "1" or "0" to indicate whether a remote machine with the identity string should be able to detach one or more seats with concurrency from the license server machine. (Only relevant when |
limit_to
|
If you specify the Key ID of a protection key installed on the license server machine, remote machines can only access licenses from that protection key. If this field is left empty, remote machines can access licenses from any protection key located on the license server machine. |
maximum_number_of_auto_registered_machines
|
Set the maximum number of machines that can use the identity string for this client identity. Possible values are: >"Unlimited" – An unlimited number of remote machines are allowed to use the identity string to access the license server machine. The machines will not be registered. >An integer value – The maximum number of remote machines that are allowed to use this identity string to access the license server machine. Each machine will be automatically registered the first time it accesses the license server machine. When the maximum number of machines are registered, no additional machines can use this identity string. |
expiration_date
|
Date on which the client identity expires. Date is expressed in unix time. |
Examples
>The following sample updates the specified client identity to allow detaching licenses and sets the maximum number of auto-registered machines to 3.
<?xml version="1.0" encoding="UTF-8"?>
<admin>
<cloud_licensing>
<update>
<identity>
<element identity_code="I4H6DUJ"/>
<element allow_remote_detach_access="1"/>
<element maximum_number_of_auto_registered_machines="3"/>
</identity>
</update>
</cloud_licensing>
</admin>
>The following sample re-enables a disabled client identity and changes the name of the client identity recipient to user235.
<?xml version="1.0" encoding="UTF-8"?>
<admin>
<cloud_licensing>
<update>
<identity>
<element identity_code="I5R5V6"/>
<element identity_status="enabled"/>
<element issued_to="user235"/>
</identity>
</update>
</cloud_licensing>
</admin>