Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_ntp_policy – Управление политиками NTP (datetime:Pol)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_ntp_policy.

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

Обзор

  • Управление настройкой политики NTP на тканях Cisco ACI.

Параметры

Параметр

Комментарии

admin_state

string

Административное состояние политики

Варианты:

  • "disabled"
  • "enabled"

annotation

string

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

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

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

Значение по умолчанию: "orchestrator:ansible"

auth_state

string

Включить аутентификацию

Варианты:

  • "disabled"
  • "enabled"

certificate_name

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

string

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

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

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

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

description

string

Описание политики NTP

host

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

string

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

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

master_mode

string

Включить режим master. Применимо только если server_state включен

Варианты:

  • "disabled"
  • "enabled"

name

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

string

Имя политики NTP

output_level

string

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

normal означает стандартный вывод, включая current dict

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

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.

private_key

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

string

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

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

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

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

server_state

string

Разрешить коммутаторам выступать в качестве NTP-серверов

Варианты:

  • "disabled"
  • "enabled"

state

string

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

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

Варианты:

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

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

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

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение.

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

Варианты:

  • false
  • true

timeout

integer

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

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

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

use_proxy

boolean

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

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

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

Варианты:

  • false
  • true

use_ssl

boolean

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

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

Значение по умолчанию true, когда подключение локальное.

Варианты:

  • false
  • true

username

aliases: user

string

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

  • false
  • true

См. также

См. также

Ссылка на справочник модели информации управления APIC

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

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

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

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

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

Примеры

- name: Add a new NTP policy
  cisco.aci.aci_ntp_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_ntp_policy
    description: via Ansible
    admin_state: enabled
    state: present
  delegate_to: localhost

- name: Remove a NTP policy
  cisco.aci.aci_ntp_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_ntp_policy
    state: absent
  delegate_to: localhost

- name: Query a NTP policy
  cisco.aci.aci_ntp_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_ntp_policy
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all NTP policies
  cisco.aci.aci_ntp_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

Ключ

Описание

current

список / элементы=строка

Текущая конфигурация с APIC после завершения модуля

Возвращается: успешно

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

error

словарь

Информация об ошибке, возвращённая APIC

Возвращается: ошибка

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

filter_string

строка

Строка фильтра, используемая для запроса

Возвращается: ошибка или отладка

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

method

строка

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

Возвращается: ошибка или отладка

Пример: "POST"

previous

список / элементы=строка

Исходная конфигурация с APIC до начала работы модуля

Возвращается: информация

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

proposed

словарь

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

Возвращается: информация

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

raw

строка

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

Возвращается: ошибка разбора

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

response

строка

HTTP ответ от APIC

Возвращается: ошибка или отладка

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

sent

список / элементы=строка

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

Возвращается: информация

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

status

целое число

HTTP статус от APIC

Возвращается: ошибка или отладка

Пример: 200

url

строка

HTTP url, используемый для запроса к APIC

Возвращается: ошибка или отладка

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

Авторы

  • Tim Cragg (@timcragg)

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

  • Система отслеживания проблем
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_ntp_policy_module.html

Spec-Zone.ru

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