Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_interface_policy_link_level – Управление политиками интерфейсов на уровне связей (fabric:HIfPol)

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в книге задач, укажите: cisco.aci.aci_interface_policy_link_level.

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

Описание

  • Политика интерфейса на уровне связей определяет параметры уровня 1 интерфейсов коммутаторов.

Параметры

Параметр

Комментарии

annotation

строка

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

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

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

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

auto_negotiation

булево

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

APIC по умолчанию использует on, если не задано при создании.

Варианты:

  • false
  • true ← (по умолчанию)

certificate_name

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

строка

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

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

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

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

description

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

строка

Описание политики интерфейса уровня Link.

forwarding_error_correction

строка

Определяет режим коррекции ошибок переадресации (FEC).

APIC по умолчанию использует inherit, если не задано при создании.

Варианты:

  • "inherit" ← (по умолчанию)
  • "kp-fec"
  • "cl91-rs-fec"
  • "cl74-fc-fec"
  • "disable-fec"
  • "ieee-rs-fec"
  • "cons16-rs-fec"

host

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

строка

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

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

link_debounce_interval

целое число

Включает таймер debounce для портов физического интерфейса и устанавливает его на указанное количество миллисекунд.

APIC по умолчанию использует 100, если не задано при создании.

По умолчанию: 100

link_level_policy

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

строка

Имя политики интерфейса уровня Link.

output_level

строка

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

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

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

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

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

Варианты:

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

output_path

строка

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

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

owner_key

строка

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

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

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

owner_tag

строка

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

Этот атрибут представляет тег для предоставления клиентам возможности добавлять свои данные.

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

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

password

строка

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

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

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

port

целое число

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

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

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

END_OF_DOCUMENT_MARKER

private_key

aliases: cert_key

string

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

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

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

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

speed

string

Определяет административную скорость порта политики интерфейса.

Опция auto поддерживается только в версии APIC 5.2 или более поздней.

APIC по умолчанию использует inherit при отсутствии значения во время создания.

Варианты:

  • "100M"
  • "1G"
  • "10G"
  • "25G"
  • "40G"
  • "50G"
  • "100G"
  • "200G"
  • "400G"
  • "auto"
  • "inherit" ← (по умолчанию)

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 fabric:HIfPol.

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

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

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

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

Примеры

- name: Add a Link Level Policy
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    link_level_policy: link_level_policy_test
    description: via Ansible
    auto_negotiation: 'on'
    speed: 100M
    link_debounce_interval: 100
    forwarding_error_correction: cl91-rs-fec
    state: present
  delegate_to: localhost

- name: Remove a Link Level Policy
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    link_level_policy: ansible_test
    state: absent

- name: Query a Link Level Policy
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    link_level_policy: link_level_policy_test
    state: query
  delegate_to: localhost

- name: Query all Link Level Policies
  cisco.aci.aci_interface_policy_link_level:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

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

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

Ключ

Описание

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 или debug

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

method

string

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

Возвращается: failure или 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

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

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

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

response

string

HTTP-ответ от APIC

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

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

sent

list / elements=string

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

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

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

status

integer

HTTP-статус от APIC

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

Пример: 200

url

string

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

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

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

Авторы

  • Vasily Prokopov (@vasilyprokopov)

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

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

© 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_interface_policy_link_level_module.html

Spec-Zone.ru

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