Spec-Zone.ru › Ansible

cisco.aci.aci_ntp_server module – Управление NTP-серверами (datetime:NtpProv)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

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

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_ntp_server.

  • Краткое описание
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

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

  • Управление конфигурацией NTP-сервера (datetimeNtpProv) в фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

Определяемая пользователем строка для аннотирования объекта.

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

Если значение не указано в задаче и переменная окружения ACI_ANNOTATION, будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

string

Имя сертификата X.509, связанного с пользователем APIC AAA, который используется для аутентификации на основе подписи.

Если было указано имя файла private_key, по умолчанию используется имя файла private_key без расширения.

Если для private_key было предоставлено содержимое в формате PEM, по умолчанию используется значение username.

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

description

string

Описание NTP-сервера

epg_name

string

Имя управляющей EPG для доступа к NTP-серверу

epg_type

string

Тип управляющей EPG для доступа к NTP-серверу: inb или oob

Варианты:

  • "inb"
  • "oob"

host

псевдонимы: hostname

string

IP-адрес или имя хоста APIC, доступное для разрешения имени с управляющего узла Ansible.

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

max_poll

integer

Максимальный интервал опроса

min_poll

integer

Минимальный интервал опроса

ntp_policy

псевдонимы: policy_name

string / обязательный

Имя существующей политики NTP

ntp_server

псевдонимы: server_name

string

Имя NTP-сервера

output_level

string

Влияет на вывод этого модуля ACI.

normal — стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

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

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

Путь к файлу, в который будут записаны созданные модулем объекты конфигурации ACI в формате JSON.

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

owner_key

string

Определяемая пользователем строка для атрибута ownerKey объекта ACI.

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

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

owner_tag

string

Определяемая пользователем строка для атрибута ownerTag объекта ACI.

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

Например, чтобы указать, кто создал этот объект.

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

password

string

Пароль для аутентификации.

Этот параметр несовместим с private_key. Если также указан private_key, будет использован он.

Если значение не указано в задаче, вместо него будут использованы переменные окружения ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

preferred

boolean

Является ли этот сервер предпочтительным NTP-сервером

Варианты:

  • false
  • true

private_key

псевдонимы: cert_key

string

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

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр несовместим с password. Если также указан password, он будет проигнорирован.

Если значение не указано в задаче, вместо него будут использованы переменные окружения ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для вывода одного или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед отправкой обновления POST в APIC не будет отправляться GET-запрос для проверки предыдущего состояния.

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

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в этом случае возвращаемое значение previous будет пустым.

Предыдущее состояние объекта не будет проверяться, а обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки обновления POST в APIC не будет отправляться проверочный GET-запрос.

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

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в этом случае для возвращаемого значения current будет установлено предложенное значение.

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

Варианты:

  • false
  • true

timeout

integer

Тайм-аут на уровне сокета в секундах.

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

Значение по умолчанию: 30.

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах.

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

Значение по умолчанию: true.

Варианты:

  • false
  • true

use_ssl

boolean

Если false, вместо HTTPS-подключения, используемого по умолчанию, будет применяться HTTP-подключение.

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

При локальном подключении значение по умолчанию — true.

Варианты:

  • false
  • true

username

псевдонимы: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будут использованы переменные окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию: admin.

validate_certs

boolean

Если false, SSL-сертификаты проверяться не будут.

Устанавливайте значение false только для контролируемых вами сайтов с самоподписанными сертификатами.

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

Значение по умолчанию: true.

Варианты:

  • false
  • true

Примечания

Примечание

  • Используемая ntp_policy должна существовать до использования этого модуля в плейбуке. Для этого можно использовать модуль cisco.aci.aci_ntp_policy.

См. также

См. также

Справочник модели управляющей информации APIC

Дополнительная информация о внутреннем классе APIC datetime:NtpProv.

Руководство по Cisco ACI

Подробная информация об управлении инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add a new NTP server
  cisco.aci.aci_ntp_server:
    host: apic
    username: admin
    password: SomeSecretPassword
    ntp_policy: my_ntp_policy
    ntp_server: 10.20.30.40
    min_poll: 3
    max_poll: 8
    preferred: true
    state: present
  delegate_to: localhost

- name: Remove a NTP server
  cisco.aci.aci_ntp_server:
    host: apic
    username: admin
    password: SomeSecretPassword
    ntp_policy: my_ntp_policy
    ntp_server: 10.20.30.40
    state: absent
  delegate_to: localhost

- name: Query a NTP server
  cisco.aci.aci_ntp_server:
    host: apic
    username: admin
    password: SomeSecretPassword
    ntp_policy: my_ntp_policy
    ntp_server: 10.20.30.40
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all NTP servers within a policy
  cisco.aci.aci_ntp_server:
    host: apic
    username: admin
    password: SomeSecretPassword
    ntp_policy: my_ntp_policy
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

current

list / elements=string

Существующая конфигурация из APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращенные APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная в запросе

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация из APIC до запуска модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе предоставленных пользователем параметров

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращенный REST API APIC (xml или json)

Возвращается: parse error

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Tim Cragg (@timcragg)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/cisco/aci/aci_ntp_server_module.html

Spec-Zone.ru

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