Spec-Zone.ru › Ansible

cisco.aci.aci_access_port_block_to_access_port модуль – Управление блоками портов интерфейсов Fabric Access Leaf/Spine (infra:PortBlk)

Примечание

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

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

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

Для использования в playbook укажите: cisco.aci.aci_access_port_block_to_access_port.

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

Описание

  • Управление блоками портов интерфейсов Fabric Access Leaf/Spine на Cisco ACI.

Параметры

Параметр

Комментарии

access_port_selector

псевдонимы: name, access_port_selector_name

строка

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

annotation

строка

Строка, определённая пользователем для аннотирования объекта.

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

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

Значение по умолчанию: "orchestrator:ansible"

certificate_name

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

строка

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

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

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

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

from_card

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

строка

Начальное значение (от-диапазон) диапазона карт для блока портов.

from_port

псевдонимы: from, fromPort, from_port_range

строка

Начальное значение (от-диапазон) диапазона портов для блока портов.

host

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

строка

IP-адрес или имя хоста, разрешаемого хостом Ansible.

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

interface_profile

псевдонимы: leaf_interface_profile_name, leaf_interface_profile, interface_profile_name, spine_interface_profile, spine_interface_profile_name

строка

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

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.

password

строка

Пароль для аутентификации.

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

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

port

целое число

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

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

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

port_blk

псевдонимы: leaf_port_blk_name, leaf_port_blk

строка

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

port_blk_description

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

строка

Описание блока портов.

private_key

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

строка

Файл закрытого ключа в формате 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, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST на APIC.

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

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

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

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

Варианты:

  • false
  • true

suppress_verification

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

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

string

Конечное (до-диапазона) диапазона карты для блока порта.

to_port

псевдонимы: to, toPort, to_port_range

string

Конечное (до-диапазона) диапазона портов для блока порта.

type

string

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

Варианты:

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

use_proxy

boolean

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

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

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

Варианты:

  • false
  • true

use_ssl

boolean

Если false, будет использоваться соединение HTTP вместо стандартного соединения HTTPS.

Если значение не указано в задаче, будет использовано значение переменной среды 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

Примечания

Примечание

  • Если добавляется блок портов на порт селектора порта доступа типа leaf, interface_profile и access_port_selector должны существовать перед использованием данного модуля в вашей книге задач. Для этого можно использовать модули cisco.aci.aci_interface_policy_leaf_profile и cisco.aci.aci_access_port_to_interface_policy_leaf_profile.
  • Если добавляется блок портов на порт селектора интерфейса доступа типа type spine, interface_profile и access_port_selector должны существовать перед использованием данного модуля в вашей книге задач. Для этого можно использовать модули cisco.aci.aci_access_spine_interface_profile и cisco.aci.aci_access_spine_interface_selector.

См. также

См. также

cisco.aci.aci_interface_policy_leaf_profile

Управление профилями политики интерфейсов Fabric для узлов листа (infra:AccPortP).

cisco.aci.aci_access_port_to_interface_policy_leaf_profile

Управление селекторами интерфейсов профилей политики интерфейсов Fabric для узлов листа (infra:HPortS, infra:RsAccBaseGrp и infra:PortBlk).

cisco.aci.aci_access_spine_interface_profile

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

cisco.aci.aci_access_spine_interface_selector

Управление селекторами портов интерфейсов Spine Fabric Access Policy (infra:SHPortS).

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Associate a Fabric access policy interface port block (single port) to an interface selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 13
    state: present
  delegate_to: localhost

- name: Associate a Fabric access policy interface port block (port range) to an interface selector
  cisco.aci.aci_access_port_block_to_access_port:
    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: Associate a Fabric access policy interface port block (single port) to an interface selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    from_port: 13
    to_port: 13
    state: present
  delegate_to: localhost

- name: Associate a Fabric access policy interface port block (port range) to an interface selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    from_port: 13
    to_port: 16
    state: present
  delegate_to: localhost

- name: Query Specific Fabric access policy interface port block under given access port selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    state: query
  delegate_to: localhost
  register: query_result

- name: Query Specific Fabric access policy interface port block under given access port selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks under given leaf interface profile
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks under given leaf interface profile of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks in the fabric
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric access policy interface port blocks in the fabric of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove a Fabric access policy interface port block from an interface selector
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    interface_profile: leafintprfname
    access_port_selector: accessportselectorname
    port_blk: leafportblkname
    from_port: 13
    to_port: 13
    state: absent
  delegate_to: localhost

- name: Remove a Fabric access policy interface port block from an interface selector of type fex
  cisco.aci.aci_access_port_block_to_access_port:
    host: apic
    username: admin
    password: SomeSecretPassword
    type: fex
    interface_profile: leafintprfname_fex
    access_port_selector: accessportselectorname_fex
    port_blk: leafportblkname_fex
    from_port: 13
    to_port: 13
    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"

Авторы

  • Simon Metzger (@smnmtzgr)
  • 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_port_block_to_access_port_module.html

Spec-Zone.ru

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