Spec-Zone.ru › Ansible 2.11

community.general.oneandone_monitoring_policy – Настройка политики мониторинга 1&1.

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.oneandone_monitoring_policy.

  • Обзор
  • Требования
  • Параметры
  • Примеры
  • Возвращаемые значения

Обзор

  • Создание, удаление, обновление политик мониторинга (а также добавление/удаление портов, процессов и серверов). Этот модуль зависит от 1and1 >= 1.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • 1and1
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
add_ports
список / элементы=строка
Порты для добавления в политику мониторинга.
add_processes
список / элементы=строка
Процессы для добавления в политику мониторинга.
add_servers
список / элементы=строка
Сервера для добавления в политику мониторинга.
agent
строка
Установить true для использования агента.
api_url
строка
Пользовательский URL API. Переопределяет переменную окружения ONEANDONE_API_URL.
auth_token
строка
Токен аутентификации API, предоставленный 1&1.
description
строка
Описание политики мониторинга. maxLength=256
email
строка
Электронная почта пользователя. maxLength=128
monitoring_policy
строка
Идентификатор (id или имя) политики мониторинга, используемой при обновлении состояния.
name
строка
Имя политики мониторинга, используемой при текущем состоянии. Используется как идентификатор (id или имя) при использовании состояния отсутствия. maxLength=128
ports
список / элементы=строка
Массив портов, которые будут отслеживаться.
alert_if
строка / обязательно
    Варианты:
  • RESPONDING
  • NOT_RESPONDING
Случай оповещения.
email_notification
строка / обязательно
Установить значение true для отправки уведомлений по электронной почте.
port
строка / обязательно
Номер порта. minimum=1, maximum=65535
protocol
строка / обязательно
    Варианты:
  • TCP
  • UDP
Интернет-протокол.
processes
список / элементы=строка
Массив процессов, которые будут отслеживаться.
alert_if
строка / обязательно
    Варианты:
  • RUNNING
  • NOT_RUNNING
Случай оповещения.
process
строка / обязательно
Имя процесса. maxLength=50
remove_ports
список / элементы=строка
Порты для удаления из политики мониторинга.
remove_processes
список / элементы=строка
Процессы для удаления из политики мониторинга.
remove_servers
список / элементы=строка
Сервера для удаления из политики мониторинга.
state
строка
    Варианты:
  • настоящее ←
  • отсутствует
  • обновить
Определите состояние политики мониторинга для создания, удаления, обновления.
thresholds
список / элементы=строка
Пороговые значения политики мониторинга. Каждый из подвариантов имеет предупреждение и критическое значение, которые оба имеют подварианты оповещения и значения. Предупреждение используется для установки пределов для предупреждений, критическая — для критических оповещений. оповещение включает оповещение, а значение используется для консультации, когда превышено значение.
cpu
строка / обязательно
Пределы потребления процессора.
disk
строка / обязательно
Пределы потребления жесткого диска.
internal_ping
строка / обязательно
Пределы ответа внутреннего пинга.
ram
строка / обязательно
Пределы потребления ОЗУ.
transfer
строка / обязательно
Пределы потребления передачи.
update_ports
список / элементы=строка
Порты, которые нужно обновить в политике мониторинга.
update_processes
список / элементы=строка
Процессы, которые нужно обновить в политике мониторинга.
wait
логическое значение
    Варианты:
  • нет
  • да ←
ожидание, пока экземпляр перейдет в состояние 'работает', перед возвратом
wait_interval
целое число
По умолчанию:
5
Определяет количество секунд ожидания при использовании методов _wait_for
wait_timeout
целое число
По умолчанию:
600
сколько времени ждать, прежде чем ожидание сдастся, в секундах

Примеры

- name: Create a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    name: ansible monitoring policy
    description: Testing creation of a monitoring policy with ansible
    email: your@emailaddress.com
    agent: true
    thresholds:
     -
       cpu:
         warning:
           value: 80
           alert: false
         critical:
           value: 92
           alert: false
     -
       ram:
         warning:
           value: 80
           alert: false
         critical:
           value: 90
           alert: false
     -
       disk:
         warning:
           value: 80
           alert: false
         critical:
           value: 90
           alert: false
     -
       internal_ping:
         warning:
           value: 50
           alert: false
         critical:
           value: 100
           alert: false
     -
       transfer:
         warning:
           value: 1000
           alert: false
         critical:
           value: 2000
           alert: false
    ports:
     -
       protocol: TCP
       port: 22
       alert_if: RESPONDING
       email_notification: false
    processes:
     -
       process: test
       alert_if: NOT_RUNNING
       email_notification: false
    wait: true

- name: Destroy a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    state: absent
    name: ansible monitoring policy

- name: Update a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy
    name: ansible monitoring policy updated
    description: Testing creation of a monitoring policy with ansible updated
    email: another@emailaddress.com
    thresholds:
     -
       cpu:
         warning:
           value: 70
           alert: false
         critical:
           value: 90
           alert: false
     -
       ram:
         warning:
           value: 70
           alert: false
         critical:
           value: 80
           alert: false
     -
       disk:
         warning:
           value: 70
           alert: false
         critical:
           value: 80
           alert: false
     -
       internal_ping:
         warning:
           value: 60
           alert: false
         critical:
           value: 90
           alert: false
     -
       transfer:
         warning:
           value: 900
           alert: false
         critical:
           value: 1900
           alert: false
    wait: true
    state: update

- name: Add a port to a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    add_ports:
     -
       protocol: TCP
       port: 33
       alert_if: RESPONDING
       email_notification: false
    wait: true
    state: update

- name: Update existing ports of a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    update_ports:
     -
       id: existing_port_id
       protocol: TCP
       port: 34
       alert_if: RESPONDING
       email_notification: false
     -
       id: existing_port_id
       protocol: TCP
       port: 23
       alert_if: RESPONDING
       email_notification: false
    wait: true
    state: update

- name: Remove a port from a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    remove_ports:
     - port_id
    state: update

- name: Add a process to a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    add_processes:
     -
       process: test_2
       alert_if: NOT_RUNNING
       email_notification: false
    wait: true
    state: update

- name: Update existing processes of a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    update_processes:
     -
       id: process_id
       process: test_1
       alert_if: NOT_RUNNING
       email_notification: false
     -
       id: process_id
       process: test_3
       alert_if: NOT_RUNNING
       email_notification: false
    wait: true
    state: update

- name: Remove a process from a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    remove_processes:
     - process_id
    wait: true
    state: update

- name: Add server to a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    add_servers:
     - server id or name
    wait: true
    state: update

- name: Remove server from a monitoring policy
  oneandone_moitoring_policy:
    auth_token: oneandone_private_api_key
    monitoring_policy: ansible monitoring policy updated
    remove_servers:
     - server01
    wait: true
    state: update

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
monitoring_policy
словарь
всегда
Информация о политике мониторинга, которая была обработана

Пример:
{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Политика по умолчанию"}


Авторы

  • Amel Ajdinovic (@aajdinov)
  • Ethan Devenport (@edevenport)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/oneandone_monitoring_policy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API