Version information
This version is compatible with:
- Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'shazi7804-ssm_agent', '0.1.1'
Learn more about managing modules with a PuppetfileDocumentation
ssm_agent
Table of Contents
- Description
- Setup - The basics of getting started with ssm_agent
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
The ssm agent module installs, configures, and manages the AWS ssm agent service across a range of operating systems and distributions.
Setup
Beginning with ssm_agent
include '::ssm_agent'
is enough to get you up and running. To pass in parameters specifying which download url to use:
class { '::ssm_agentntp':
ssm_agent_url => 'https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/amazon-ssm-agent.deb',
}
Usage
All parameters for the ntp module are contained within the main ::ssm_agent
class, so for any function of the module, set the options you want. See the common usages below for examples.
Install and enable SSM Agent
include '::ssm_agent'
Change SSM Agent download package
class { '::ssm_agent':
ssm_agent_url => 'https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/debian_amd64/amazon-ssm-agent.deb',
}
Configuring SSM Agent to Use a Proxy
class { '::ssm_agent':
http_proxy => 'http://change.proxy.com:3128',
no_proxy => '169.254.169.254',
}
Reference
Classes
Public classes
- ssm_agent: Main class, includes all other classes.
Private classes
- ssm_agent::install: Handles the packages.
- ssm_agent::config: Handles the configuration file.
- ssm_agent::service: Handles the service.
- ssm_agent::onpremises: Handles the On-Premises setting.
Parameters
The following parameters are available in the ::ssm_agent
class:
ssm_agent_url
Optional.
Data type: String.
The ssm agent download url
Default value: https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/$OS_VER/amazon-ssm-agent.{dev,rpm}
.
proxy_install_manage
Optional.
Data type: Boolean.
Enables the use of agents to download the source code
Default value: false
proxy_install_manage_timeout
Optional.
Data type: String.
Connect timeout use of agents to download the source code
Default value: 3
Dependencies
- puppetlabs-stdlib (>= 1.0.0)