Spec-Zone.ru › Ansible 2.5

nxos_ntp — Управляет основной конфигурацией NTP.

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Состояние
    • Поддержка
    • Автор

Обзор

  • Управляет основной конфигурацией NTP.

Параметры

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

Примечания

Примечание

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

Примеры

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

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

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

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

Пример:
True
end_state
dict
всегда
параметры ntp после выполнения модуля

Пример:
{'source': '3.3.3.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'}
existing
dict
всегда
параметры существующих ntp серверов/peer

Пример:
{'source': 'ethernet2/1', 'source_type': 'source-interface', 'key_id': '32', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'}
proposed
dict
всегда
переданные в модуль параметры

Пример:
{'source': '3.3.3.3', 'source_type': 'source', 'key_id': '48', 'peer_type': 'server', 'address': '2.2.2.2', 'prefer': 'enabled'}
updates
list
всегда
команды, отправленные на устройство

Пример:
['ntp server 2.2.2.2 prefer key 48', 'no ntp source-interface ethernet2/1', 'ntp source 3.3.3.3']


Состояние

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

Поддержка

Для получения дополнительной информации о поддержке этого модуля Red Hat, пожалуйста, обратитесь к этой статье базы знаний

Автор

  • 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.5/modules/nxos_ntp_module.html

Spec-Zone.ru

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