logicmonitor - Управление вашей учетной записью LogicMonitor с помощью Ansible Playbooks

Новое в версии 2.2.

Обзор
Требования (для хоста, на котором выполняется модуль)
Параметры
Примеры
Значения возврата
Примечания
- Статус

Обзор

LogicMonitor — это хостинг-платформа для инфраструктурного мониторинга с полным набором функций.
Этот модуль управляет хостами, группами хостов и коллекторами в вашей учетной записи LogicMonitor.

Требования (для хоста, на котором выполняется модуль)

Существующая учетная запись LogicMonitor
Linux

Параметры

параметр	обязательно	значение по умолчанию	возможные значения	комментарии
action	да		add remove update sdt	Действие, которое вы хотите выполнить с целевым объектом. Add: Добавление объекта в вашу учетную запись LogicMonitor. Remove: Удаление объекта из вашей учетной записи LogicMonitor. Update: Обновление свойств, описания или групп (target=host) объекта в вашей учетной записи LogicMonitor. SDT: Планирование простоя для объекта в вашей учетной записи LogicMonitor.
alertenable	нет	True	True False	Логическое значение для включения или выключения оповещений для объекта. Необязательно для управления всеми хостами (action=add или action=update).
collector	нет			Полное доменное имя коллектора в вашей учетной записи LogicMonitor. Требуется для создания хоста LogicMonitor (target=host action=add). Требуется для обновления, удаления или планирования простоя для хостов, если 'displayname' не указан (target=host action=update action=remove action=sdt).
company	да			Название компании в учетной записи LogicMonitor. Если вы вошли в свою учетную запись по адресу "superheroes.logicmonitor.com", используйте "superheroes".
description	нет			Подробное текстовое описание объекта в вашей учетной записи LogicMonitor. Необязательно для управления хостами и группами хостов (target=host или target=hostgroup; action=add или action=update).
displayname	нет	hostname -f		Имя отображения хоста в вашей учетной записи LogicMonitor или желаемое имя отображения устройства для управления. Необязательно для управления хостами (target=host).
duration	нет	30		Продолжительность запланированного простоя (SDT) в минутах. Необязательно для ввода объекта в SDT (action=sdt).
fullpath	нет			Полный путь к объекту группы хостов, который вы хотите управлять. Рекомендуется выполнять на одном хосте Ansible. Требуется для управления группами хостов LogicMonitor (target=hostgroup).
groups	нет			Список групп, членом которых должен быть хост. Необязательно для управления хостами (target=host; action=add или action=update).
hostname	нет	hostname -f		Имя хоста в вашей учетной записи LogicMonitor или желаемое имя хоста для управления. Необязательно для управления хостами (target=host).
id	нет			Идентификатор источника данных, на который должна быть направлена цель. Требуется для управления источниками данных LogicMonitor (target=datasource).
password	да			Пароль указанного пользователя LogicMonitor
properties	нет			Словарь свойств для установки на хост или группу хостов LogicMonitor. Необязательно для управления хостами и группами хостов (target=host или target=hostgroup; action=add или action=update). Этот параметр добавит или обновит существующие свойства в вашей учетной записи LogicMonitor.
starttime	нет	Сейчас		Время начала запланированного простоя (SDT). Необязательно для управления SDT (action=sdt). ГГГГ-ММ-ДД ЧЧ:ММ
target	да		collector host datsource hostgroup	Тип объекта LogicMonitor, который вы хотите управлять. Collector: Выполнение действий с коллектором LogicMonitor. ПРИМЕЧАНИЕ Для управления службами Collector 'logicmonitor-agent' и 'logicmonitor-watchdog' следует использовать модули сервиса Ansible, такие как service или supervisorctl. В частности, после добавления коллектора вам, скорее всего, потребуется запустить эти службы, а перед удалением - остановить. Host: Выполнение действий с устройством хоста. Hostgroup: Выполнение действий с группой хостов LogicMonitor. ПРИМЕЧАНИЕ Задачи хостов и групп хостов всегда должны выполняться через delegate_to: localhost. Нет никаких преимуществ в выполнении этих задач на удалённом хосте, и это обычно приведёт к проблемам.
user	да			Имя пользователя LogicMonitor. Модуль будет аутентифицироваться и выполнять действия от имени этого пользователя.

Примеры

# example of adding a new LogicMonitor collector to these devices
---
- hosts: collectors
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Deploy/verify LogicMonitor collectors
    become: yes
    logicmonitor:
      target: collector
      action: add
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'

#example of adding a list of hosts into monitoring
---
- hosts: hosts
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Deploy LogicMonitor Host
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: host
      action: add
      collector: mycompany-Collector
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      groups: /servers/production,/datacenter1
      properties:
        snmp.community: secret
        dc: 1
        type: prod
    delegate_to: localhost

#example of putting a datasource in SDT
---
- hosts: localhost
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: SDT a datasource
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: datasource
      action: sdt
      id: 123
      duration: 3000
      starttime: '2017-03-04 05:06'
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'

#example of creating a hostgroup
---
- hosts: localhost
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Create a host group
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: add
      fullpath: /servers/development
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      properties:
        snmp.community: commstring
        type: dev

#example of putting a list of hosts into SDT
---
- hosts: hosts
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: SDT hosts
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: host
      action: sdt
      duration: 3000
      starttime: '2016-11-10 09:08'
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      collector: mycompany-Collector
    delegate_to: localhost

#example of putting a host group in SDT
---
- hosts: localhost
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: SDT a host group
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: sdt
      fullpath: /servers/development
      duration: 3000
      starttime: '2017-03-04 05:06'
      company=: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'

#example of updating a list of hosts
---
- hosts: hosts
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Update a list of hosts
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: host
      action: update
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      collector: mycompany-Collector
      groups: /servers/production,/datacenter5
      properties:
        snmp.community: commstring
        dc: 5
    delegate_to: localhost

#example of updating a hostgroup
---
- hosts: hosts
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Update a host group
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: update
      fullpath: /servers/development
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      properties:
        snmp.community: hg
        type: dev
        status: test
    delegate_to: localhost

#example of removing a list of hosts from monitoring
---
- hosts: hosts
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Remove LogicMonitor hosts
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: host
      action: remove
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      collector: mycompany-Collector
    delegate_to: localhost

#example of removing a host group
---
- hosts: hosts
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Remove LogicMonitor development servers hostgroup
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: remove
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      fullpath: /servers/development
    delegate_to: localhost
  - name: Remove LogicMonitor servers hostgroup
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: remove
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      fullpath: /servers
    delegate_to: localhost
  - name: Remove LogicMonitor datacenter1 hostgroup
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: remove
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      fullpath: /datacenter1
    delegate_to: localhost
  - name: Remove LogicMonitor datacenter5 hostgroup
    # All tasks except for target=collector should use delegate_to: localhost
    logicmonitor:
      target: hostgroup
      action: remove
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      fullpath: /datacenter5
    delegate_to: localhost

### example of removing a new LogicMonitor collector to these devices
---
- hosts: collectors
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Remove LogicMonitor collectors
    become: yes
    logicmonitor:
      target: collector
      action: remove
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'

#complete example
---
- hosts: localhost
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Create a host group
    logicmonitor:
      target: hostgroup
      action: add
      fullpath: /servers/production/database
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      properties:
        snmp.community: commstring
  - name: SDT a host group
    logicmonitor:
      target: hostgroup
      action: sdt
      fullpath: /servers/production/web
      duration: 3000
      starttime: '2012-03-04 05:06'
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'

- hosts: collectors
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: Deploy/verify LogicMonitor collectors
    logicmonitor:
      target: collector
      action: add
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
  - name: Place LogicMonitor collectors into 30 minute Scheduled downtime
    logicmonitor:
      target: collector
      action: sdt
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
  - name: Deploy LogicMonitor Host
    logicmonitor:
      target: host
      action: add
      collector: agent1.ethandev.com
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      properties:
        snmp.community: commstring
        dc: 1
      groups: /servers/production/collectors, /datacenter1
    delegate_to: localhost

- hosts: database-servers
  remote_user: '{{ username }}'
  vars:
    company: mycompany
    user: myusername
    password: mypassword
  tasks:
  - name: deploy logicmonitor hosts
    logicmonitor:
      target: host
      action: add
      collector: monitoring.dev.com
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
      properties:
        snmp.community: commstring
        type: db
        dc: 1
      groups: /servers/production/database, /datacenter1
    delegate_to: localhost
  - name: schedule 5 hour downtime for 2012-11-10 09:08
    logicmonitor:
      target: host
      action: sdt
      duration: 3000
      starttime: '2012-11-10 09:08'
      company: '{{ company }}'
      user: '{{ user }}'
      password: '{{ password }}'
    delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для данного модуля:

имя	описание	возвращается	тип	пример
success	Флаг, указывающий, что выполнение прошло успешно	success	boolean	True

Примечания

Примечание

Для работы этого модуля необходима существующая учетная запись LogicMonitor.

Статус

Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.

Для получения помощи в разработке модулей, если вас это интересует, обратитесь к Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/logicmonitor_module.html