REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• zendhq: Manage ZendHQ package, service, and configuration

Private Classes

• zendhq::config: Configure zendhq.ini settings
• zendhq::package: Manage the zendhqd package
• zendhq::service: Manage zendhq service

Defined types

Private Defined types

• zendhq::config::setting: Configure a zendhqd.ini setting

Tasks

• group_add: Create a group
• group_add_user: Add one or more users to a group
• group_comment: Set a comment for a given group
• group_disable: Disable a given group
• group_enable: Enable a given group
• group_list: List the defined groups
• group_print: List the permissions for a given group
• group_remove: Remove a given group
• group_remove_user: Remove one or more users from a group
• group_set_permissions: Set the permissions for a given group
• user_add: Create a user
• user_add_group: Add a user to one or more groups
• user_comment: Set a comment for a given user
• user_disable: Disable a given user
• user_enable: Enable a given user
• user_list: List the defined users
• user_password: Change the password for a given user
• user_print: List the permissions for a given user
• user_remove: Remove a given user
• user_remove_group: Remove a user from one or more groups

Classes

zendhq

Manage ZendHQ package, service, and configuration

• See also
  • https://help.zend.com/zendphp/current/content/zendhq/zendhq_service_configuration.htm
    • for possible settings

Examples

Basic ZendHQ setup

class { 'zendhq':
  license_source => 'puppet:///modules/<MODULE_NAME>/zend/license'
}

Setup ZendHQ with some configuration

class { 'zendhq':
  license_source => 'puppet:///modules/<MODULE_NAME>/zend/license',
  settings       => {
    'zendhq.daemon_uri' => 'tcp://0.0.0.0:10090',
  },
}

Parameters

The following parameters are available in the zendhq class:

• license_source
• settings
• service_provider
• service_ensure
• service_name
• service_enable
• package_ensure
• package_name

license_source

Data type: String[1]

Source path or puppet URL to license file

settings

Data type: Optional[Hash[String, Variant[String, Integer]]]

Hash of settings and their values

Default value: undef

service_provider

Data type: Optional[String[1]]

System service provider, like systemctl; auto-detected if left undef

Default value: undef

service_ensure

Data type: Enum['running', 'stopped']

Enure value for the ZendHQ service

Default value: 'running'

service_name

Data type: String[1]

Name of ZendHQ service

Default value: 'zendhqd'

service_enable

Data type: Boolean

Whether the service should be enabled or not

Default value: true

package_ensure

Data type: String[1]

Ensure value for the ZendHQ package

Default value: 'installed'

package_name

Data type: String[1]

Name of the ZendHQ package

Default value: 'zendhqd'

Tasks

group_add

Create a group

Supports noop? false

Parameters

group

Data type: String[1]

Group to create

comment

Data type: Optional[String[1]]

Optional group comment

permissions

Data type: Optional[String[1]]

Optional permission mask, such as 'r zray,mon,conf,ct,jq'

group_add_user

Add one or more users to a group

Supports noop? false

Parameters

group

Data type: String[1]

Group to add one or more users to

user

Data type: String[1]

User(s) to add to the group

group_comment

Set a comment for a given group

Supports noop? false

Parameters

group

Data type: String[1]

Group to set comment for

comment

Data type: Optional[String[1]]

Comment for given group

group_disable

Disable a given group

Supports noop? false

Parameters

group

Data type: String[1]

Group to disable

group_enable

Enable a given group

Supports noop? false

Parameters

group

Data type: String[1]

Group to enable

group_list

List the defined groups

Supports noop? false

group_print

List the permissions for a given group

Supports noop? false

Parameters

group

Data type: String[1]

Group to list the permissions of

group_remove

Remove a given group

Supports noop? false

Parameters

group

Data type: String[1]

Group to remove

group_remove_user

Remove one or more users from a group

Supports noop? false

Parameters

group

Data type: String[1]

Group to remove one or more users from

user

Data type: String[1]

User(s) to remove from the group

group_set_permissions

Set the permissions for a given group

Supports noop? false

Parameters

group

Data type: String[1]

Group to set the permissions of

permissions

Data type: String[1]

Permission mask, such as '-wx zray,mon,conf,ct,jq'

user_add

Create a user

Supports noop? false

Parameters

user

Data type: String[1]

User to create

password

Data type: Optional[String[1]]

Password for user

group

Data type: Optional[String[1]]

Optional group or comma-separated list of groups to add user to

comment

Data type: Optional[String[1]]

Optional user comment

disable

Data type: Optional[String[1]]

Optional disable user flag

user_add_group

Add a user to one or more groups

Supports noop? false

Parameters

user

Data type: String[1]

User to add to group(s)

group

Data type: String[1]

Group or comma-separated list of groups

user_comment

Set a comment for a given user

Supports noop? false

Parameters

user

Data type: String[1]

User to set comment for

comment

Data type: Optional[String[1]]

Comment for given user

user_disable

Disable a given user

Supports noop? false

Parameters

user

Data type: String[1]

User to disable

user_enable

Enable a given user

Supports noop? false

Parameters

user

Data type: String[1]

User to enable

user_list

List the defined users

Supports noop? false

user_password

Change the password for a given user

Supports noop? false

Parameters

user

Data type: String[1]

User to change password for

password

Data type: String[1]

Password for given user

user_print

List the permissions for a given user

Supports noop? false

Parameters

user

Data type: String[1]

User to list the permissions of

user_remove

Remove a given user

Supports noop? false

Parameters

user

Data type: String[1]

User to remove

user_remove_group

Remove a user from one or more groups

Supports noop? false

Parameters

user

Data type: String[1]

User to remove from group(s)

group

Data type: String[1]

Group or comma-separated list of groups