REFERENCE.md

Reference

Table of Contents

Classes

• ccs_hcu: Install hcu-specific stuff.
• ccs_hcu::advec: Add (or remove) the advantech EC modules. Replaces the older imanager.
• ccs_hcu::aiousb: Install aiousb.
• ccs_hcu::canbus: Add (or remove) the lion canbus module.
• ccs_hcu::filter_changer: Add (or remove) filter changer device links
• ccs_hcu::ft4232h: Add settings for FT4232H device.
• ccs_hcu::imanager: Add (or remove) the iManager module.
• ccs_hcu::power: Add (or remove) hcu shutdown utilities
• ccs_hcu::pth450: Install Dracal USB pth450 support.
• ccs_hcu::shutter: Install shutter utilities.
• ccs_hcu::vldrive: Add (or remove) the lion vldrive module.

Defined types

• ccs_hcu::dkms: Configure DKMS for module

Classes

ccs_hcu

Install hcu-specific stuff.

Parameters

The following parameters are available in the ccs_hcu class:

• quadbox
• advec
• canbus
• vldrive
• imanager
• filter_changer
• aiousb
• shutter
• ft4232h
• pth450
• pkgurl
• pkgurl_user
• pkgurl_pass

quadbox

Data type: Boolean

True if this is a quadbox host.

Default value: false

advec

Data type: Variant[Boolean,String]

True (or 'present') if need specified module; false (or 'absent') removes it; 'nothing' does nothing.

Default value: false

canbus

Data type: Variant[Boolean,String]

True (or 'present') if need specified module; false (or 'absent') removes it; 'nothing' does nothing.

Default value: false

vldrive

Data type: Variant[Boolean,String]

True (or 'present') if need specified module; false (or 'absent') removes it; 'nothing' does nothing.

Default value: false

imanager

Data type: Variant[Boolean,String]

True (or 'present') if need specified module; false (or 'absent') removes it; 'nothing' does nothing.

Default value: false

filter_changer

Data type: Variant[Boolean,String]

True (or 'present') to install; false (or 'absent') to remove.

Default value: false

aiousb

Data type: Boolean

True to install aiousb.

Default value: false

shutter

Data type: Boolean

True to install shutter utilities.

Default value: false

ft4232h

Data type: Boolean

true or false to enable ft4232h.

Default value: false

pth450

Data type: Boolean

True to install Dracal USB-PTH450 sensor support.

Default value: false

pkgurl

Data type: String

String specifying URL to fetch sources from.

Default value: 'https://example.org'

pkgurl_user

Data type: Variant[Sensitive[String[1]],String[1]]

String specifying username to access pkgurl.

Default value: Sensitive('someuser')

pkgurl_pass

Data type: Sensitive[String[1]]

String specifying password to access pkgurl.

Default value: Sensitive('somepass')

ccs_hcu::advec

https://www.advantech.com/en-us/support/details/software-api?id=1-2JZ4BXI

Parameters

The following parameters are available in the ccs_hcu::advec class:

• ensure
• module
• version

ensure

Data type: String

String saying whether to install ('present') or remove ('absent') module.

Default value: 'nothing'

module

Data type: String

Module name.

Default value: 'advec'

version

Data type: String

Version string.

Default value: '2.24'

ccs_hcu::aiousb

Install aiousb.

ccs_hcu::canbus

Add (or remove) the lion canbus module.

Parameters

The following parameters are available in the ccs_hcu::canbus class:

• ensure
• module
• version

ensure

Data type: String

String saying whether to install ('present') or remove ('absent') module.

Default value: 'nothing'

module

Data type: String

Module name.

Default value: 'advSocketCAN'

version

Data type: String

Version string.

Default value: '1.0.1.0'

ccs_hcu::filter_changer

Add (or remove) filter changer device links

Parameters

The following parameters are available in the ccs_hcu::filter_changer class:

• ensure

ensure

Data type: String

String saying whether to install ('present') or remove ('absent').

Default value: 'absent'

ccs_hcu::ft4232h

Add settings for FT4232H device.

ccs_hcu::imanager

Add (or remove) the iManager module.

Parameters

The following parameters are available in the ccs_hcu::imanager class:

• ensure
• module
• version

ensure

Data type: String

String saying whether to install ('present') or remove ('absent') module.

Default value: 'nothing'

module

Data type: String

Module name.

Default value: 'imanager'

version

Data type: String

Version string.

Default value: '1.5.0'

ccs_hcu::power

Add (or remove) hcu shutdown utilities

Parameters

The following parameters are available in the ccs_hcu::power class:

• ensure
• quadbox

ensure

Data type: String

String saying whether to install ('present') or remove ('absent').

Default value: 'absent'

quadbox

Data type: Boolean

Boolean true on quadbox hosts

Default value: false

ccs_hcu::pth450

Install Dracal USB pth450 support.

Parameters

The following parameters are available in the ccs_hcu::pth450 class:

• tarfile

tarfile

Data type: String

Name of tarfile to install.

Default value: 'dracalview-client-bin-3.2.2.tar.xz'

ccs_hcu::shutter

Install shutter utilities.

ccs_hcu::vldrive

Add (or remove) the lion vldrive module.

Parameters

The following parameters are available in the ccs_hcu::vldrive class:

• ensure
• module
• version

ensure

Data type: String

String saying whether to install ('present') or remove ('absent') module.

Default value: 'nothing'

module

Data type: String

Module name.

Default value: 'versaapi'

version

Data type: String

Version string.

Default value: '1.5.0'

Defined types

ccs_hcu::dkms

Configure DKMS for module

Parameters

The following parameters are available in the ccs_hcu::dkms defined type:

• ensure
• module
• version
• archive

ensure

Data type: Enum['present', 'absent']

String saying whether to install ('present') or remove ('absent') module.

module

Data type: String

Name of module

version

Data type: String

Version String

archive

Data type: String

Name of Archive resource to order upon.