Version information
This version is compatible with:
- Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
- Puppet >= 7.24 < 9.0.0
- , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'solarwinds-uamsclient', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
Puppet UAMS Client module
The Puppet UAMS Client module installs and configures UAMS Client.
Table of Contents
Description
The uamsclient Puppet module is designed to install and configure the SolarWinds Observability Agent on supported operating systems. This agent enables host monitoring, which collects data about the performance, stability, and overall health of your hosts. By utilizing this module, administrators can monitor both cloud-based virtual machines and standard servers, ensuring proactive issue resolution and service planning.
Setup
To set up the uamsclient Puppet module, define the class with the necessary parameters to install and configure the SolarWinds Observability Agent on your host.
Module Installation
To install the uamsclient module, you can use the following command:
puppet module install solarwinds-uamsclient
Usage
Usage of UAMS Client puppet module.
UAMS Client Installation
To install the UAMSClient agent using this module, you need to define the class uamsclient with the appropriate parameters. Below is an example of how to use this module to install the UAMS Client:
class { 'uamsclient':
uams_access_token => '<uams_access_token>',
swo_url => 'na-01.cloud.solarwinds.com',
uams_metadata => 'role:host-monitoring',
}
Parameters
uams_access_token: This is the access token required for authenticating with the UAMS service. You must replace '<uams_access_token>' with your actual UAMS access token.swo_url: This is the URL endpoint for the UAMS service. The default URL is 'na-01.cloud.solarwinds.com', but you can replace it with the appropriate URL for your region or service.uams_metadata: This is the metadata used for identifying the role and purpose of the host. To enable basic host monitoring, the uams_metadata variable should contain 'role:host-monitoring'.uams_override_hostname: Optional variable to set a custom Agent name. By default, Agent name is set to the hostname.
UAMS Client Uninstallation
If you need to uninstall the UAMSClient agent, you can use the uamsclient::uninstall class. This class will remove the UAMSClient package and ensure that related files and services are no longer present on the system. Below is an example of how to use this module to uninstall the UAMS Client:
class { 'uamsclient::uninstall': }
Requirements
- Puppet 7 or later
SolarWinds Observability Agents work on most systems. The following lists the platforms that have been tested and verified to work with the Agents:
- Amazon Linux 2 and later
- CentOS 6 and later
- Debian 10 and later
- Fedora 32 and later
- Kali 2021 and later
- OpenSUSE 15 and later
- Oracle Linux 8 and later
- RedHat 7.1 and later
- Rocky Linux 8 and later
- SUSE Linux Enterprise Server 15 and later
- Ubuntu 18.04 and later
More information about agent system requirements can be found here.
Dependencies:
- puppetlabs-stdlib: >=4.25.0 <10.0.0
Contributing
We welcome contributions! Please see our Contributing Guide for more details.
Reference
Table of Contents
Classes
uamsclient: Class for install and manage uamsclientuamsclient::container: Class for preparing container environment for testsuamsclient::params: Class containing default settings according to operating systemuamsclient::set_package_manager: Class for determining the package manager and package type for the OS.uamsclient::uninstall: Class for UAMS Client uninstallationuamsclient::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_pathinstall_pkg_urldev_container_testuamsclient_work_diruamsclient_ctluams_access_tokenswo_urluams_metadatauams_override_hostname
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
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
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
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
Dependencies
- puppetlabs/stdlib (>=4.25.0 <10.0.0)
Copyright 2024 SolarWinds, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.