Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_access_port_to_interface_policy_leaf_profile — Управление политиками интерфейсов листовых профилей ткани (infra:HPortS, infra:RsAccBaseGrp и infra:PortBlk)

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр

Комментарии

access_port_selector

aliases: name, access_port_selector_name

string

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

annotation

string

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

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

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

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

description

string

Описание для назначения access_port_selector

fex_id

integer

Идентификатор профиля FEX, допустимый идентификатор FEX находится в диапазоне от 101 до 199.

fex_profile

aliases: fex_profile_name

string

Имя профиля FEX. Значение fex_profile переопределяется policy_group.

from_card

aliases: from_card_range

string

Устарело

Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.

Параметр будет удален в Ansible 2.12.

<hr>

Начало (from-range) блока диапазона плат для блока портов доступа уровня.

from_port

aliases: from, fromPort, from_port_range

string

Устарело

Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to-access_port вместо этого.

Параметр будет удален в Ansible 2.12.

<hr>

Начало (from-range) блока диапазона портов для блока портов доступа уровня.

host

aliases: hostname

string

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

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

interface_profile

aliases: leaf_interface_profile_name, leaf_interface_profile, interface_profile_name

string

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

interface_type

string

Тип интерфейса для статического развертывания EPG.

interface_type fex_profile не может быть настроен с профилем типа fex.

Варианты:

  • "breakout"
  • "fex"
  • "port_channel"
  • "switch_port" ← (по умолчанию)
  • "vpc"
  • "fex_port_channel"
  • "fex_vpc"
  • "fex_profile"

leaf_port_blk_description

string

Устарело

Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.

Параметр будет удален в Ansible 2.12.

<hr>

Описание для назначения leaf_port_blk

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.

policy_group

aliases: policy_group_name

string

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

port

integer

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

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

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

port_blk

aliases: leaf_port_blk_name, leaf_port_blk, port_blk_name

string

Устарело

Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.

Параметр будет удалён в Ansible 2.12.

<hr>

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

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

timeout

integer

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

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

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

to_card

aliases: to_card_range

string

Устарело

Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо этого.

Параметр будет удалён в Ansible 2.12.

<hr>

Конечное значение (диапазон до) блока диапазона карт для блока порта доступа к интерфейсу листа.
END_OF_DOCUMENT_MARKER

to_port

aliases: to, toPort, to_port_range

string

Устаревший

Начиная с Ansible 2.8, рекомендуется использовать cisco.aci.aci_access_port_block_to_access_port вместо него.

Параметр будет удален в Ansible 2.12.

<hr>

Конечный (to-range) диапазон портов для блока доступа к порту лист.

type

aliases: profile_type

string

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

Варианты:

  • "fex"
  • "leaf" ← (по умолчанию)

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

Примечания

Примечание

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

См. также

См. также

cisco.aci.aci_access_port_block_to_access_port

Управление блоками портов Fabric Access Leaf/Spine Interface Port Selectors (infra:PortBlk).

APIC Management Information Model reference

Дополнительная информация о внутренних классах 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)
  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

- name: Create and Bind Access Port Selector with Fex Profile Policy Group
  cisco.aci.aci_access_port_to_interface_policy_leaf_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_interface_profile: leafintprftest
    fex_profile: fexintprftest
    policy_group: fexintprftest
    access_port_selector_name: anstest_fex_accessportselector
    interface_type: fex_profile
    from_port: 13
    to_port: 13
    port_blk: block2
    fex_id: 105
    state: present
  delegate_to: localhost

- name: Create and Bind Access Port Selector with PC 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
    policy_group: pcintprftest
    access_port_selector_name: anstest_pc_accessportselector
    interface_type: port_channel
    port_blk: leafportblkname
    from_port: 13
    to_port: 13
    state: present
  delegate_to: localhost

- name: Create and Bind Access Port Selector with VPC 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
    policy_group: vpcintprftest
    access_port_selector_name: anstest_vpc_accessportselector
    interface_type: vpc
    port_blk: leafportblkname
    from_port: 13
    to_port: 13
    state: present
  delegate_to: localhost

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

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

Ключ

Описание

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

строка

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

Возвращено: ошибка разбора

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

Авторы

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

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

  • Трекер проблем
  • Репозиторий (источники)

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

Spec-Zone.ru

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