Houdini 20.5 Installation And Licensing Licensing Public API

Update Partition Rules

Update the partition rules for the given license set.

This function will either update existing rules, create new ones, or delete existing rules.

Function: cmd_up_part_rules
Version: 20.0+

Argument Name

Type

Description

user

string

The user@machine_name the request is originating from. This is used to check if the user has the required permissions to update the license set.

id

string

The id of the license set to apply the updated partition rules to.

rules

array of json objects

Information for each of the rules to update, create, or delete.

json rule object

{
"delete": false,
"condition": "product=='Houdini-Master'",
"quantity": 1,
"id": "",
}

Property

Type

Description

delete

boolean

Indicates the existing partition rule should be deleted.

condition

string

The condition of the partition rule.

quantity

int

The quantity property of the partition rule.

id

string

The id of the partition rule. If the id is missing its considered as a new partition rule and it will be added. If the id is provided then an existing rule is updated. This is required when deleting partition rules.

response

{
    "success": false,
    "id": "",
    "rules": [
        {
        "success": false,
        "id": "",
        "condition": "",
        "deleted": false
        }
    ]
}

Key

Type

Description

success

boolean

True if updating the user rules was a success.

id

string

The id of the license set which the partition rules were applied to.

rules

object

The list of partition rules that were updated.

rules.success

boolean

True if the update for the partition rule was a success.

rules.id

string

The id of the partition rule that was updated.

rules.condition

string

The current condition of the partition rule.

rules.deleted

boolean

True if the partition rule was deleted.

Licensing Public API

Administrative

Licenses

Partition System

Server

  • Ping

    Ping the server to see if its responsive.

  • Refresh DNS Cache

    Inform sesinetd to refresh its DNS cache.

Webhook