Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_access_spine_interface_selector — Управление политиками доступа к ткани на интерфейсах ядра спины (infra:SHPortS)

Примечание

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

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

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

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

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

Описание

  • Управление политиками доступа к ткани на интерфейсах ядра спины Cisco ACI.
  • Этот селектор используется для применения инфраструктурных политик к выбранным портам.

Параметры

Параметр

Комментарии

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

Описание селектора порта интерфейса spine.

host

aliases: hostname

string

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

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

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая словари previous, proposed и sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

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

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

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

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

port

integer

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

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

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

private_key

aliases: cert_key

string

Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Эта опция взаимоисключающая с password. Если также предоставлен password, он будет проигнорирован.

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

selector_type

aliases: type

string

Тип селектора порта хоста.

При использовании блока портов для указания диапазона интерфейсов тип должен быть установлен в range.

Choices:

  • "all"
  • "range"

spine_interface_profile

aliases: spine_interface_profile_name, interface_profile, interface_profile_name

string

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

spine_interface_selector

aliases: name, spine_interface_selector_name, interface_selector, interface_selector_name, access_port_selector, access_port_selector_name

string

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

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.

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

Примечания

Примечание

  • spine_interface_profile должен существовать до использования этого модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_access_spine_interface_profile.
  • Если используется policy_group, он должен существовать до использования этого модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_interface_policy_spine_policy_group.

См. также

См. также

cisco.aci.aci_access_port_block_to_access_port

Управление блоками портов интерфейсов Port Selectors (infra:PortBlk).

cisco.aci.aci_interface_policy_spine_policy_group

Управление группами политик интерфейсов позвоночника (infra:SpAccPortGrp).

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Add a new access spine interface selector
  cisco.aci.aci_access_spine_interface_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_interface_profile: my_access_spine_interface_profile
    spine_interface_selector: my_access_spine_interface_selector
    selector_type: range
    policy_group: my_access_spine_interface_policy_group
    state: present
  delegate_to: localhost

- name: Query a specific access spine interface selector under given spine_interface_profile
  cisco.aci.aci_access_spine_interface_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_interface_profile: my_access_spine_interface_profile
    spine_interface_selector: my_access_spine_interface_selector
    selector_type: range
    state: query
  delegate_to: localhost

- name: Query all access spine interface selectors under given spine_interface_profile
  cisco.aci.aci_access_spine_interface_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_interface_profile: my_access_spine_interface_profile
    state: query
  delegate_to: localhost

- name: Query all access spine interface selectors
  cisco.aci.aci_access_spine_interface_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove an access spine interface selector
  cisco.aci.aci_access_spine_interface_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_interface_profile: my_access_spine_interface_profile
    spine_interface_selector: my_access_spine_interface_selector
    selector_type: range
    state: absent
  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"

Авторы

  • Gaspard Micol (@gmicol)

Ссылки на сборку

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

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

Spec-Zone.ru

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