Модуль graphiant.naas.graphiant_ntp — управление объектами NTP на уровне устройства (edge.ntpGlobalObject)

Примечание

Этот модуль входит в коллекцию graphiant.naas (версия 26.4.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install graphiant.naas. Для работы с этим модулем также требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: graphiant.naas.graphiant_ntp.

Добавлено в graphiant.naas 26.2.0

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Настраивает или удаляет объекты NTP на уровне устройства в edge.ntpGlobalObject.
Читает структурированный файл конфигурации YAML и формирует полезную нагрузку конфигурации устройства в Python.
Настройка идемпотентна: сравнивает заданные объекты с текущим состоянием устройства и не отправляет конфигурацию, если состояние уже совпадает.
Отмена настройки удаляет только объекты, указанные в YAML, задавая config: null для каждого объекта.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.7
graphiant-sdk >= 25.12.1

Параметры

Параметр	Комментарии
access_token string	Токен Bearer для аутентификации API (например, полученный с помощью `graphiant login`, который открывает браузер для входа (SSO или без SSO) и получает токен). Если токен не передан как аргумент модуля, коллекция считывает `GRAPHIANT_ACCESS_TOKEN` (устанавливается после `graphiant login` при выполнении `source ~/.graphiant/env.sh`). Если токен Bearer указан (в аргументе модуля или в переменной среды), он имеет приоритет над `username` и `password`. Если действительный токен недоступен, модуль выполняет аутентификацию с помощью `username` и `password`, если указаны оба параметра.
detailed_logs boolean	Включить подробное журналирование. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url string / обязательный	URL узла портала Graphiant для подключения к API. Пример: “https://api.graphiant.com”
ntp_config_file string / обязательный	Путь к файлу YAML с конфигурацией NTP. Путь может быть абсолютным или относительным к настроенному config_path. Ожидаемый ключ верхнего уровня — `ntpGlobalObject` (список устройств).
operation string	Операция для выполнения. `configure` создает или обновляет объекты NTP, указанные в конфигурации. `deconfigure` удаляет указанные объекты NTP, задавая `config=null`. Варианты: `"configure"` `"deconfigure"`
password string	Пароль портала Graphiant для аутентификации. Обязателен для входа по паролю, если действительный токен Bearer недоступен через `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
state string	Требуемое состояние объектов NTP. `present` соответствует `configure`; `absent` соответствует `deconfigure`, если операция не задана. Варианты: `"present"` ← (по умолчанию) `"absent"`
username string	Имя пользователя портала Graphiant для аутентификации. Обязательно для входа по паролю, если действительный токен Bearer недоступен через `access_token` или `GRAPHIANT_ACCESS_TOKEN`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная В режиме проверки конфигурация не отправляется на устройства, но модуль считывает текущее состояние устройств, чтобы определить, потребуются ли изменения. Полезные нагрузки, которые были бы отправлены, записываются в журнал с префиксом `[check_mode]`.	Поддерживает режим проверки.

Примечания

Примечание

Этот модуль управляет объектами NTP непосредственно на устройствах (API конфигурации устройств), а не глобальной конфигурацией портала.
Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамического формирования конфигурации.
Полезная нагрузка для отмены настройки использует config: null для каждого объекта; модуль сохраняет значения null в итоговой полезной нагрузке, отправляемой в API.

Примеры

- name: Configure device-level NTP objects
  graphiant.naas.graphiant_ntp:
    operation: configure
    ntp_config_file: "sample_device_ntp.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: ntp_result
  no_log: true

- name: Deconfigure device-level NTP objects
  graphiant.naas.graphiant_ntp:
    operation: deconfigure
    ntp_config_file: "sample_device_ntp.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

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

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

Ключ	Описание
changed boolean	Указывает, будет ли конфигурация отправлена хотя бы на одно устройство. В режиме проверки (`--check`) конфигурация не отправляется, но `changed` отражает, будут ли внесены изменения. Возвращается: всегда
configured_devices list / элементы=string	Имена устройств, на которые была отправлена конфигурация (если changed=true). Возвращается: при поддержке
msg string	Сообщение о результате (включает подробные журналы, если они включены). Возвращается: всегда
ntp_config_file string	Файл конфигурации NTP, использованный для операции. Возвращается: всегда
operation string	Выполненная операция. Возвращается: всегда
skipped_devices list / элементы=string	Имена устройств, которые были пропущены, поскольку требуемое состояние уже достигнуто. Возвращается: при поддержке

Авторы

Команда Graphiant (@graphiant)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/graphiant/naas/graphiant_ntp_module.html