On this page
sensu.sensu_go.agent – Install, configure, and start Sensu Go agent
Note
This role is part of the sensu.sensu_go collection (version 1.12.0).
To install it use: ansible-galaxy collection install sensu.sensu_go.
To use it in a playbook, specify: sensu.sensu_go.agent.
Entry point configure – Configure Sensu Go agent
  Synopsis
- Write the Sensu Go agent configuration file.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| agent_config
        
        dictionary
         | 
      
        
        Any option that is valid for the Sensu Go agent version we are installing.
        
       
        All valid options are listed at https://docs.sensu.io/sensu-go/latest/reference/agent/#configuration.
        
       
        Role copies the key-value pairs from the agent_config variable verbatim to the configuration file. This means that we must copy the key names exactly as they appear in the configuration reference. In a way, the agent_config variable should contain a properly indented copy of the  /etc/sensu/agent.yml file.
        | 
     
Entry point main – Install, configure, and start Sensu Go agent
  Synopsis
- Install, configure, and start the Sensu Go agent service.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| agent_config
        
        dictionary
         | 
      
        
        Any option that is valid for the Sensu Go agent version we are installing.
        
       
        All valid options are listed at https://docs.sensu.io/sensu-go/latest/reference/agent/#configuration.
        
       
        Role copies the key-value pairs from the agent_config variable verbatim to the configuration file. This means that we must copy the key names exactly as they appear in the configuration reference. In a way, the agent_config variable should contain a properly indented copy of the  /etc/sensu/agent.yml file.
        | 
     |
| build
        
        string
         | 
      Default: 
        "latest"
         | 
      
        
        Package build to install.
        
       
        Can be any valid build string such as  
       8290 or a special value latest.
       
        If the version variable is set to latest, this variable is ignored and the latest available build is installed.
         | 
     
| channel
        
        string
         | 
      Default: 
        "stable"
         | 
      
        
        Repository channel that serves as a source of packages.
        
       
        Visit the packagecloud site to find all available channels.
         | 
     
| version
        
        string
         | 
      Default: 
        "latest"
         | 
      
        
        Package version to install.
        
       
        Can be any valid version string such as  6.2.5 or special value latest.
        | 
     
Entry point start – Start Sensu Go agent
  Synopsis
- Start the Sensu Go agent service.
 
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/agent_role.html