Forge Home

uamsclient

Puppet module for UAMS Client installation

209 downloads

111 latest version

3.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.0 (latest)
  • 0.1.27 (deleted)
  • 0.1.25 (deleted)
  • 0.1.23 (deleted)
  • 0.1.1 (deleted)
  • 0.1.0 (deleted)
released Aug 20th 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 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

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'solarwinds-uamsclient', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add solarwinds-uamsclient
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install solarwinds-uamsclient --version 1.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

solarwinds/uamsclient — version 1.0.0 Aug 20th 2024

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.