Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

annotation

строка

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

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

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

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

certificate_name

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

строка

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

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

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

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

description

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

строка

Описание канала портов.

fast_select

логическое

Определяет, включен ли быстрый выбор для горячих резервных портов.

Это формирует политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределёнными или установленные в ложь, не будут существовать после выполнения задачи.

APIC по умолчанию устанавливает true, если это не задано при создании.

Варианты:

  • false
  • true

graceful_convergence

логическое

Определяет, включена ли плавная сходимость.

Это формирует политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределёнными или установленные в ложь, не будут существовать после выполнения задачи.

APIC по умолчанию устанавливает true, если это не задано при создании.

Варианты:

  • false
  • true

host

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

строка

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

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

load_defer

логическое

Определяет, включено ли отложенное загрузка.

Это формирует политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределёнными или установленные в ложь, не будут существовать после выполнения задачи.

APIC по умолчанию устанавливает false, если это не задано при создании.

Варианты:

  • false
  • true

max_links

целое число

Максимальное количество связей.

Допустимые значения находятся в диапазоне от 1 до 16.

APIC по умолчанию устанавливает 16, если это не задано при создании.

min_links

целое число

Минимальное количество связей.

Допустимые значения находятся в диапазоне от 1 до 16.

APIC по умолчанию устанавливает 1, если это не задано при создании.

mode

строка

Режим политики канала портов.

Определяет метод LACP для формирования каналов портов.

APIC по умолчанию устанавливает off, если это не задано при создании.

Варианты:

  • "active"
  • "mac-pin"
  • "mac-pin-nicload"
  • "off"
  • "passive"

name_alias

строка

Псевдоним текущего объекта. Это относится к полю nameAlias в ACI.

output_level

строка

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

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

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

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

string

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

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

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

port

integer

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

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

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

port_channel

aliases: name

string

Имя канала портов.

private_key

aliases: 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

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

suspend_individual

boolean

Определяет, включена ли функция Suspend Individual.

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

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

Варианты:

  • false
  • true

symmetric_hash

boolean

Определяет, включено ли симметричное хеширование.

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

APIC использует значение по умолчанию 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 Management Information Model reference

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

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

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

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

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

Примеры

- name: Create a Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    mode: active
    min_links: 1
    max_links: 16
    state: present
  delegate_to: localhost

- name: Delete a Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    state: absent
  delegate_to: localhost

- name: Query all Port Channel interface policies
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    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"}}}
... (rest of the table)

Авторы

  • Dag Wieers (@dagwieers)

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

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

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

Spec-Zone.ru

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