Spec-Zone.ru › Ansible 2.10

cisco.nxos.nxos_ntp – Управляет основными настройками NTP.

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).

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

Для использования в playbook, укажите: cisco.nxos.nxos_ntp.

Новое в версии 1.0.0: модуля cisco.nxos

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

Описание

  • Управляет основными настройками NTP.

Примечание

Для этого модуля существует соответствующий плагин действий.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
key_id
строка
Идентификатор ключа аутентификации для использования с заданным NTP-сервером или узлом, или ключевое слово 'default'.
peer
строка
Сеть адрес NTP узла.
prefer
строка
    Варианты:
  • enabled
  • disabled
Делает заданный NTP-сервер или узел предпочтительным NTP-сервером или узлом для устройства.
provider
словарь
Устаревшее поле
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.
Этот параметр будет удален в релизе после 2022-06-01.
Для получения дополнительной информации см. руководство NXOS Platform Options.
Объект словаря, содержащий данные соединения.
auth_pass
строка
Указывает пароль для использования, если требуется для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент не имеет значения. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
булево
    Варианты:
  • нет ←
  • да
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE.
host
строка
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD.
port
целое число
Указывает порт для использования при создании подключения к удалённому устройству. Это значение применимо к cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
ssh_keyfile
строка
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
transport
строка
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
use_proxy
булево
    Варианты:
  • нет
  • да ←
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
use_ssl
булево
    Варианты:
  • нет ←
  • да
Настраивает transport для использования SSL, если установлено yes, только когда transport=nxapi, в противном случае это значение игнорируется.
username
строка
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
validate_certs
булево
    Варианты:
  • нет ←
  • да
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент transport не nxapi, это значение игнорируется.
server
строка
Сеть адрес NTP сервера.
source_addr
строка
Локальный исходный адрес, с которого отправляются NTP-сообщения, или ключевое слово 'default'.
source_int
строка
Локальный исходный интерфейс, с которого отправляются NTP-сообщения. Должно быть полное имя интерфейса или ключевое слово 'default'.
state
строка
    Варианты:
  • present ←
  • absent
Управление состоянием ресурса.
vrf_name
строка
Устанавливает связь устройства с заданным NTP-сервером или узлом через определённую VPN или ключевое слово 'default'.

Примечания

Примечание

  • Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
  • Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
  • Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.

Примеры

# Set NTP Server with parameters
- cisco.nxos.nxos_ntp:
    server: 1.2.3.4
    key_id: 32
    prefer: enabled
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

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

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

Ключ Возвращённое значение Описание
changed
булево
всегда
проверка, были ли внесены изменения на устройстве

Пример:
True
end_state
словарь
всегда
пара ключ/значение ntp информации после выполнения модуля

Пример:
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'источник'}
existing
словарь
всегда
пара ключ/значение существующего ntp сервера/узла

Пример:
{'address': '192.0.2.2', 'key_id': '32', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': 'ethernet2/1', 'source_type': 'интерфейс-источник'}
proposed
словарь
всегда
пара ключ/значение параметров, переданных в модуль

Пример:
{'address': '192.0.2.2', 'key_id': '48', 'peer_type': 'сервер', 'prefer': 'enabled', 'source': '192.0.2.3', 'source_type': 'источник'}
updates
список / элементы=строка
всегда
команда, отправленная устройству

Пример:
['ntp сервер 192.0.2.2 prefer ключ 48', 'нет ntp интерфейс-источник ethernet2/1', 'ntp источник 192.0.2.3']


Авторы

  • Jason Edelman (@jedelman8)

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

Spec-Zone.ru

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