Spec-Zone.ru › Ansible

модуль cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group – Управление группой политик FEX профиля интерфейсов leaf (infra:FexBndlGrp)

Примечание

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

annotation

string

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

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

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

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

certificate_name

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

string

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

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

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

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

fex_profile

string

Имя профиля FEX.

host

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

string

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

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

name

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

string

Имя группы политик профиля FEX.

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.

port

integer

Номер порта для REST-подключения.

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

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

private_key

псевдонимы: 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

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед POST-обновлением APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым.

Предыдущее состояние объекта не будет проверено, а POST-обновление будет содержать все свойства.

Допустимые значения:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после POST-обновления APIC проверочный GET-запрос отправлен не будет.

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

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

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение current будет установлено в предложенное значение.

Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Допустимые значения:

  • false
  • true

timeout

integer

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

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

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

use_proxy

boolean

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

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

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

Допустимые значения:

  • false
  • true

use_ssl

boolean

Если false, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение.

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

При локальном подключении значение по умолчанию — true.

Допустимые значения:

  • false
  • true

username

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

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него используются значения переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

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

validate_certs

boolean

Если false, сертификаты SSL проверяться не будут.

Устанавливайте значение false только на контролируемых вами сайтах, использующих самоподписанные сертификаты.

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

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

Допустимые значения:

  • false
  • true

См. также

См. также

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

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

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

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

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

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

Примеры

- name: Add a new fex policy group
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fex_policy_group
    fex_profile: anstest_fex_profile
    state: present
  delegate_to: localhost

- name: Add list of fex policy groups
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: "{{ item.name }}"
    fex_profile: "{{ item.fex_profile }}"
    state: present
  delegate_to: localhost
  with_items:
    - name: fex_policy_group_1
      fex_profile: anstest_fex_profile
    - name: fex_policy_group_2
      fex_profile: anstest_fex_profile

- name: Query a fex policy group under fex profile
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fex_policy_group
    fex_profile: anstest_fex_profile
    state: query
  delegate_to: localhost

- name: Query all fex policy groups under fex profile
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    fex_profile: anstest_fex_profile
    state: query
  delegate_to: localhost

- name: Query all fex policy groups with name
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fex_policy_group
    state: query
  delegate_to: localhost

- name: Query all fex policy groups
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove fex policy group
  cisco.aci.aci_interface_policy_leaf_profile_fex_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fex_policy_group
    fex_profile: anstest_fex_profile
    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 или debug

Пример: "?rsp-prop-include=config-only"

method

string

HTTP-метод, использованный для запроса к APIC

Возвращается: failure или 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 или debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

HTTP-статус, полученный от APIC

Возвращается: failure или debug

Пример: 200

url

string

HTTP URL, использованный для запроса к APIC

Возвращается: failure или debug

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

Авторы

  • Sabari Jaganathan (@sajagana)

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

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

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

Spec-Zone.ru

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