REFERENCE.md

Reference

Table of Contents

Classes

• uamsclient: Class for install and manage uamsclient
• uamsclient::container: Class for preparing container environment for tests
• uamsclient::params: Class containing default settings according to operating system
• uamsclient::set_package_manager: Class for determining the package manager and package type for the OS.
• uamsclient::uninstall: Class for UAMS Client uninstallation
• uamsclient::validate_inputs: Class for validation user inputs

Defined types

• uamsclient::environment_variable: Defines a environment variables

Classes

uamsclient

Installs and configures UAMS Client

Parameters

The following parameters are available in the uamsclient class:

• uams_local_pkg_path
• install_pkg_url
• dev_container_test
• uamsclient_work_dir
• uamsclient_ctl
• uams_access_token
• swo_url
• uams_metadata
• uams_override_hostname
• uams_managed_locally
• local_config_template_parameters

uams_local_pkg_path

Data type: String[1]

Path to temporary UAMS directory

Default value: $uamsclient::params::uams_local_pkg_path

install_pkg_url

Data type: String[1]

URL to UAMS Client installer

Default value: $uamsclient::params::install_pkg_url

dev_container_test

Data type: Boolean

Indicates if it is a container installation

Default value: $uamsclient::params::dev_container_test

uamsclient_work_dir

Data type: String[1]

Path to UAMS Client workdir

Default value: $uamsclient::params::uamsclient_work_dir

uamsclient_ctl

Data type: String[1]

Path to uamsclient-ctl binary

Default value: $uamsclient::params::uamsclient_ctl

uams_access_token

Data type: String[1]

UAMS Client access token

Default value: undef

swo_url

Data type: String[1]

SWO URL to the desired endpoint

Default value: undef

uams_metadata

Data type: Optional[String[1]]

UAMS Client installation metadata

Default value: undef

uams_override_hostname

Data type: Optional[String[1]]

Optional variable to set a custom Agent name. By default, Agent name is set to the hostname.

Default value: undef

uams_managed_locally

Data type: Optional[Boolean]

Optional variable is used to set Agent as managed locally by configuration file.

Default value: undef

local_config_template_parameters

Data type: Optional[Hash]

Optional variable to set a hash with variables used to fill local config template file.

Default value: { }

uamsclient::container

Class for preparing container environment for tests

uamsclient::params

Class containing default settings according to operating system

uamsclient::set_package_manager

Class for determining the package manager and package type for the OS.

uamsclient::uninstall

Class for UAMS Client uninstallation

Parameters

The following parameters are available in the uamsclient::uninstall class:

• uams_local_pkg_path
• dev_container_test

uams_local_pkg_path

Data type: String[1]

Path to temporary UAMS directory

Default value: $uamsclient::params::uams_local_pkg_path

dev_container_test

Data type: Boolean

Indicates if it is a container installation

Default value: $uamsclient::params::dev_container_test

uamsclient::validate_inputs

Class for validation user inputs

Defined types

uamsclient::environment_variable

Defines a environment variables

Parameters

The following parameters are available in the uamsclient::environment_variable defined type:

• variable_name
• value
• ensure

variable_name

Data type: String

Name of environment variable

value

Data type: String

Value of environment variable

ensure

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

Sets or deletes the specified environment variable

Default value: present