модуль cisco.aci.aci_interface_policy_leaf_fc_policy_group — управление группами политик интерфейсов Fibre Channel (FC) (infra:FcAccBndlGrp и infra:FcAccPortGrp)

Примечание

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

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

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

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

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

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

Управление группами политик интерфейсов Fibre Channel (FC) на фабриках Cisco ACI.

Параметры

Параметр	Описание
annotation строка	Определяемая пользователем строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и задана переменная окружения `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
attached_entity_profile псевдонимы: aep_name, aep строка	Имя профиля подключённых сущностей (AEP), используемого группой политик интерфейсов Fibre Channel (FC).
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, связанного с пользователем APIC AAA и используемого для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание группы политик интерфейсов Fibre Channel (FC).
fibre_channel_interface_policy псевдонимы: fibre_channel_interface_policy_name строка	Имя политики интерфейса Fibre Channel, используемой группой политик интерфейсов Fibre Channel (FC).
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
lag_type псевдонимы: lag_type_name строка / обязательный	Выбор типа группы политик интерфейсов Fibre Channel (FC). `port` для Fibre Channel (FC) `port_channel` для порт-канала Fibre Channel (FC PC) Варианты: `"port"` `"port_channel"`
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 строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, будет использован он. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
policy_group псевдонимы: name, policy_group_name строка	Имя группы политик интерфейсов Fibre Channel (FC).
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
port_channel_policy псевдонимы: port_channel_policy_name строка	Имя политики порт-канала, используемой группой политик интерфейсов Fibre Channel (FC).
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.
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`

Примечания

Примечание

При использовании модуля выберите подходящий тип агрегации каналов (lag_type).
port для Fibre Channel (FC), port_channel для порт-канала Fibre Channel (VPC).

См. также

Справочник по модели управления информацией APIC: Дополнительные сведения о внутренних классах APIC infra:FcAccPortGrp и infra:FcAccBndlGrp.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Create a Fiber Channel (FC) Interface Policy Group
  cisco.aci.aci_interface_policy_leaf_fc_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: port
    fibre_channel_interface_policy: fcinterfacepolicy
    description: policygroupname description
    attached_entity_profile: aep
    state: present
  delegate_to: localhost

- name: Create a Fiber Channel Port Channel (FC PC) Interface Policy Group
  cisco.aci.aci_interface_policy_leaf_fc_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: port_channel
    fibre_channel_interface_policy: fcinterfacepolicy
    description: policygroupname description
    attached_entity_profile: aep
    port_channel_policy: lacppolicy
    state: present
  delegate_to: localhost

- name: Query all Leaf Access Port Policy Groups of type link
  cisco.aci.aci_interface_policy_leaf_fc_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: port_channel
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Lead Access Port Policy Group
  cisco.aci.aci_interface_policy_leaf_fc_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: port
    policy_group: policygroupname
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete an Interface policy Leaf Policy Group
  cisco.aci.aci_interface_policy_leaf_fc_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: port
    policy_group: policygroupname
    state: absent
  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 or debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure or 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	Исходные данные, возвращённые REST API 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 or debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: failure or debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Anvitha Jain (@anvjain)

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

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