Spec-Zone.ru › Ansible 2.11

cisco.aci.aci_access_port_to_interface_policy_leaf_profile – Управление политикой интерфейса Fabric (профиль листа) селекторами интерфейсов (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).

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

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_port_selector
строка
Имя селектора порта профиля интерфейса листа Fabric политики доступа.

псевдонимы: name, access_port_selector_name
annotation
строка
Определённая пользователем строка для аннотации объекта.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION.
certificate_name
строка
Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи.
Если предоставлено имя файла private_key, по умолчанию используется имя файла private_key, без расширения.
Если для private_key предоставлено содержимое в формате PEM, по умолчанию используется значение username.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

псевдонимы: cert_name
description
строка
Описание, которое нужно назначить access_port_selector
from_card
строка
Устарело
Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.
Параметр будет удалён в Ansible 2.12.
Начальное значение (от-диапазона) диапазона карт для блока интерфейса доступа листа.

псевдонимы: from_card_range
from_port
строка
Устарело
Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.
Параметр будет удалён в Ansible 2.12.
Начальное значение (от-диапазона) диапазона портов для блока интерфейса доступа листа.

псевдонимы: from, fromPort, from_port_range
host
строка / обязательно
IP-адрес или имя хоста, разрешаемое хостом управления Ansible.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST.

псевдонимы: hostname
interface_profile
строка
Имя профиля интерфейса листа Fabric политики доступа.

псевдонимы: leaf_interface_profile_name, leaf_interface_profile, interface_profile_name
interface_type
строка
    Варианты:
  • breakout
  • fex
  • port_channel
  • switch_port ←
  • vpc
Тип интерфейса для статического развертывания EPG.
leaf_port_blk_description
строка
Устарело
Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.
Параметр будет удалён в Ansible 2.12.
Описание, которое нужно назначить leaf_port_blk
output_level
строка
    Варианты:
  • debug
  • info
  • normal ←
Влияет на вывод этого модуля ACI.
normal означает стандартный вывод, включая current dict
info добавляет информационный вывод, включая previous, proposed и sent dicts
debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию
Если значение не указано в задаче, будет использовано значение переменной среды ACI_OUTPUT_LEVEL.
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.
policy_group
строка
Имя группы политики доступа Fabric, которое должно быть ассоциировано с селектором интерфейса профиля интерфейса листа.

псевдонимы: policy_group_name
port
целое число
Номер порта, используемый для подключения REST.
Значение по умолчанию зависит от параметра use_ssl.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_PORT.
port_blk
строка
Устарело
Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.
Параметр будет удалён в Ansible 2.12.
Имя блока порта доступа листа Fabric политики доступа.

псевдонимы: leaf_port_blk_name, leaf_port_blk, port_blk_name
private_key
строка
Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи.
Это значение также влияет на значение по умолчанию certificate_name, которое используется.
Этот параметр взаимоисключает password. Если password также предоставлен, он будет проигнорирован.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_PRIVATE_KEY.

псевдонимы: cert_key
state
строка
    Варианты:
  • absent
  • present ←
  • query
Используйте present или absent для добавления или удаления.
Используйте query для перечисления объекта или нескольких объектов.
timeout
целое число
Значение по умолчанию:
30
Таймаут уровня сокета в секундах.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_TIMEOUT.
to_card
строка
Устарело
Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.
Параметр будет удалён в Ansible 2.12.
Конечное значение (до-диапазона) диапазона карт для блока интерфейса доступа листа.

псевдонимы: to_card_range
to_port
строка
Устарело
Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.
Параметр будет удалён в Ansible 2.12.
Конечное значение (до-диапазона) диапазона портов для блока интерфейса доступа листа.

псевдонимы: to, toPort, to_port_range
type
строка
    Варианты:
  • fex
  • leaf ←
Тип порта доступа, который будет создан в соответствующем профиле.
use_proxy
булево
    Варианты:
  • no
  • yes ←
Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_PROXY.
use_ssl
булево
    Варианты:
  • no
  • yes ←
Если no, вместо подключения по HTTPS будет использоваться соединение по HTTP.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_SSL.
username
строка
Значение по умолчанию:
"admin"
Имя пользователя для аутентификации.
Если значение не указано в задаче, будут использованы значения переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

псевдонимы: user
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены.
Это следует установить только в no при использовании на сайтах, контролируемых лично, с самозаверенными сертификатами.
Если значение не указано в задаче, будет использовано значение переменной среды ACI_VALIDATE_CERTS.

Примечания

Примечание

  • Модуль interface_profile должен существовать перед использованием этого модуля в вашем плейбуке. Модули cisco.aci.aci_interface_policy_leaf_profile могут быть использованы для этого.

См. также

См. также

cisco.aci.aci_access_port_block_to_access_port

Официальная документация по модулю cisco.aci.aci_access_port_block_to_access_port.

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

Дополнительная информация о внутренних классах APIC infra:HPortS, infra:RsAccBaseGrp и infra:PortBlk.

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

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

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

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

Примеры

- name: Associate an Interface Access Port Selector to an Interface Policy Leaf Profile with a Policy Group
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 16
    policy_group: policygroupname
    state: present
  delegate_to: localhost

- name: Associate an interface access port selector to an Interface Policy Leaf Profile (w/o policy group) (check if this works)
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 16
    state: present
  delegate_to: localhost

- name: Remove an interface access port selector associated with an Interface Policy Leaf Profile
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    state: absent
  delegate_to: localhost

- name: Remove an interface access port selector associated with an Interface Policy Fex Profile
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: fexintprfname
    access_port_selector: accessportselectorname
    state: absent
  delegate_to: localhost

- name: Query Specific access_port_selector under given leaf_interface_profile
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    state: query
  delegate_to: localhost
  register: query_result

- name: Query Specific access_port_selector under given Fex leaf_interface_profile
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: fexintprfname
    access_port_selector: accessportselectorname
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ Возвращаемое значение Описание
current
список / элементы=строка
успех
Настройка, существующая в APIC после завершения модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error
словарь
ошибка
Информация об ошибке, возвращенная APIC

Пример:
{'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string
строка
ошибка или отладка
Строка фильтра, используемая для запроса

Пример:
?rsp-prop-include=config-only
method
строка
ошибка или отладка
Метод HTTP, используемый для запроса к APIC

Пример:
POST
previous
список / элементы=строка
информация
Исходная конфигурация из APIC до запуска модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed
словарь
информация
Собранная конфигурация из параметров пользователя

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw
строка
ошибка разбора
Необработанный вывод, возвращенный API APIC REST (xml или json)

Пример:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response
строка
ошибка или отладка
Ответ HTTP от APIC

Пример:
OK (30 байт)
sent
список / элементы=строка
информация
Фактическая/минимальная конфигурация, отправленная в APIC

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status
целое число
ошибка или отладка
Статус HTTP от APIC

Пример:
200
url
строка
ошибка или отладка
Используемый HTTP-url для запроса к APIC

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


Авторы

  • Bruno Calogero (@brunocalogero)
  • Shreyas Srish (@shrsr)

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

Spec-Zone.ru

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