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

Примечание

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

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

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

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

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_port_selector псевдонимы: name, access_port_selector_name строка	Имя селектора порта доступа профиля интерфейса leaf политики доступа фабрики.
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 строка	Описание, назначаемое объекту `access_port_selector`
fex_id целое число	Идентификатор профиля FEX. Допустимый идентификатор FEX — от 101 до 199.
fex_profile псевдонимы: fex_profile_name строка	Имя профиля FEX. Значение fex_profile переопределяется параметром policy_group.
from_card псевдонимы: from_card_range строка	Устарел Начиная с Ansible 2.8 рекомендуется вместо этого использовать cisco.aci.aci_access_port_block_to_access_port. Параметр будет удален в Ansible 2.12. Начало диапазона карт (from-range) блока портов доступа leaf.
from_port псевдонимы: from, fromPort, from_port_range строка	Устарел Начиная с Ansible 2.8 рекомендуется вместо этого использовать cisco.aci.aci_access_port_block_to_access_port. Параметр будет удален в Ansible 2.12. Начало диапазона портов (from-range) блока портов доступа leaf.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_HOST`.
interface_profile псевдонимы: leaf_interface_profile_name, leaf_interface_profile, interface_profile_name строка	Имя профиля интерфейса leaf политики доступа фабрики.
interface_type строка	Тип интерфейса для статического развертывания EPG. Для interface_type fex_profile нельзя настроить профиль типа fex. Варианты: `"breakout"` `"fex"` `"port_channel"` `"switch_port"` ← (по умолчанию) `"vpc"` `"fex_port_channel"` `"fex_vpc"` `"fex_profile"`
leaf_port_blk_description строка	Устарел Начиная с Ansible 2.8 рекомендуется вместо этого использовать cisco.aci.aci_access_port_block_to_access_port. Параметр будет удален в Ansible 2.12. Описание, назначаемое объекту `leaf_port_blk`
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 строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также задан `private_key`, будет использоваться он. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
policy_group псевдонимы: policy_group_name строка	Имя группы политик доступа фабрики, связываемой с селектором интерфейса профиля интерфейса leaf.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PORT`.
port_blk псевдонимы: leaf_port_blk_name, leaf_port_blk, port_blk_name строка	Устарел Начиная с Ansible 2.8 рекомендуется вместо этого использовать cisco.aci.aci_access_port_block_to_access_port. Параметр будет удален в Ansible 2.12. Имя блока портов доступа профиля интерфейса leaf политики доступа фабрики.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также задан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, перед отправкой POST-запроса на обновление в APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не проверяется, а POST-запрос на обновление содержит все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое значение	Если `true`, после POST-запроса на обновление в APIC проверочный GET-запрос отправлен не будет. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате текущее возвращаемое значение будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут сокета в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию — 30.
to_card псевдонимы: to_card_range строка	Устарел Начиная с Ansible 2.8 рекомендуется вместо этого использовать cisco.aci.aci_access_port_block_to_access_port. Параметр будет удален в Ansible 2.12. Конец диапазона карт (to-range) блока портов доступа leaf.
to_port псевдонимы: to, toPort, to_port_range строка	Устарел Начиная с Ansible 2.8 рекомендуется вместо этого использовать cisco.aci.aci_access_port_block_to_access_port. Параметр будет удален в Ansible 2.12. Конец диапазона портов (to-range) блока портов доступа leaf.
type псевдонимы: profile_type строка	Тип порта доступа, создаваемого в соответствующем профиле. Варианты: `"fex"` `"leaf"` ← (по умолчанию)
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs логическое значение	Если `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: Управление блоками портов селекторов портов интерфейсов leaf/spine фабрики (infra:PortBlk).
Справочник модели информационного управления 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)
  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 list / elements=string	Текущая конфигурация APIC после завершения работы модуля Возвращается: при успехе Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Сведения об ошибке, полученные от APIC Возвращается: при сбое Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, использованная для запроса Возвращается: при сбое или в режиме отладки Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: `"POST"`
previous list / elements=string	Исходная конфигурация APIC до запуска модуля Возвращается: в информационном режиме Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Сформированная конфигурация на основе параметров, предоставленных пользователем Возвращается: в информационном режиме Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод 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 string	Ответ HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: в информационном режиме Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: при сбое или в режиме отладки Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: при сбое или в режиме отладки Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

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

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

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