Houdini 20.5 Installation And Licensing Licensing Public API

Retrieving key list information

Retrieve server information from sesinetd.

This function can retrieve general server information and license information.

Function: cmd_ls
Version: 19.5+

Argument Name	Type Description
short_form	boolean	Short form the response for both licenses and server information.
expires	int	The number of days from now that the license expires.
server_data	boolean	Include the server data in the response.
show_all	boolean	Show all licenses found in the license file. Expired and invalid licenses are included.
show_version	boolean	Include the server version in the response.
only_version	boolean	Only include the server version in the response.
show_users	boolean	Include user information with each license.
show_licenses	boolean	Include license information with the response.

response

{
    "server": {
        "version": "",
        "host": "",
        "ids": [""],
        "id": "",
        "ip_address",
        "r_ip_mask": {
            "ipv4": "",
            "ipv6": ""
        },
        "w_ip_mask": {
            "ipv4": "",
            "ipv6": ""
        },
        "enabled_sockets": false,
        "enabled_http": false,
        "enabled_https": false,
        "write_access": false,
        "write_perm_code": 0,
        "redundant": false
    },
    "licenses": [
        {
            "product": "",
            "product_id": "",
            "version": "",
            "total_tokens": 0,
            "platform": "",
            "available": 0,
            "id": "",
            "start_date": "",
            "servable": false,
            "ipmatch": false,
            "error": "",
            "signature": "",
            "ipmask": "",
            "license_access_mode": "",
            "expires": "",
            "servers": "",
            "users": [
                {
                    "id": 0,
                    "user": "",
                    "checkout": ""
                }
            ]
        }
    ],
    "servers": [
        {
            "name": "",
            "id": "",
        }
    ],
    "errors": [""]
}

Key	Type	Description
server	object	The information about the server.
server.version	string	The version of the license server.
server.host	string	The hostname of the license server.
server.ids	string array	The list of all server ids of the license server.
server.id	string	One of the server ids of the license server. This property is deprecated.
server.ip_address	object	The ip address information for the license server.
server.r_ip_mask	object	The read mask information for ipv4 and ipv6.
server.r_ip_mask.ipv4	string	The read ip mask for ipv4.
server.r_ip_mask.ipv6	string	The read ip mask for ipv6.
server.w_ip_mask.ipv4	string	The write ip mask for ipv4.
server.w_ip_mask.ipv6	string	The write ip mask for ipv6.
enabled_sockets	boolean	True if the server supports the legacy communication protocol.
enabled_http	boolean	True if the server supports http communication.
enabled_https	boolean	True if the server supported https communication.
write_acess	boolean	True if the server was write access to the license directory.
write_perm_code	integer	Indicates if the user has write access. 0=Ok, no problems 1=Unknown Error, an issue of unknown origin has occurred 2=IP Error, the client requested the information does not have write access 3=File, the server does not have write access to the necessary files.
redundant	boolean	This is an unused property and is deprecated.
licenses	object array	List of all installed licenses.
licenses.product	string	The display name of the product for the license. If the server does not know the product type then this will be equal to product_id.
licenses.product_id	string	The internal name of the product for the license.
licenses.version	string	The version of the license.
licenses.total_tokens	integer	The total number of seats that the license has available.
licenses.platform	integer	This indicates the platform of the license. This is a deprecated property and can be ignored.
licenses.available	integer	The available licenses seats that can be checked out.
licenses.id	string	The id of the license.
licenses.start_date	string	The optional start date for the license. This allows a license to be installed prior to it being available.
licenses.servable	boolean	Indicates if the license can be checked out. There are a number of factors that determine this such as expiration date, server name, etc.
licenses.ipmatch	boolean	Indicates if the ip mask for the license matches the ip from the request. This is a deprecated property.
licenses.error	string	Description of why the license might not be servable.
licenses.signature	string	The signature of the license.
licenses.ipmask	string	The ipmask of the license.
licenses.license_access_mode	string	The license access mode (LAM) of the license.
licenses.expires	string	The expiration date of the license.
licenses.servers	string	The list of servers listed on the license. All licenses will list this as exactly one server.
licenses.users	object array	The list of users currently holding a license seat.
licenses.users.id	integer	The id of the license seat. License seats are randomly generated which means these should not be cached after the seat has been checked back in.
licenses.users.user	string	The user@machine of the user that currently holds the license seat.
servers	object array	The list of server ids installed to the license server.
servers.name	string	The name on the server license.
servers.id	string	The id listed on the server license.
errors	string array	Any errors that may have occurred while generating the information.

Retrieving key list information

Licensing Public API

Administrative ¶

Licenses ¶

Partition System ¶

Server ¶

Webhook ¶