Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).

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

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

  • Обзор
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_port_selector
строка
Имя селектора порта доступа профиля интерфейса листа политики доступа к ткани.

псевдонимы: name, access_port_selector_name
annotation
строка
Пользовательская строка для аннотации объекта.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_ANNOTATION.
certificate_name
строка
Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.
Если был предоставлен файл с именем private_key, по умолчанию используется имя файла private_key без расширения.
Если для private_key был предоставлен контент в формате PEM, по умолчанию используется значение username.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_CERTIFICATE_NAME.

псевдонимы: cert_name
from_card
строка
Начальное значение (от-диапазон) диапазона карт для блока порта доступа листа.

псевдонимы: from_card_range
from_port
строка
Начальное значение (от-диапазон) диапазона портов для блока порта доступа листа.

псевдонимы: from, fromPort, from_port_range
host
строка / обязательно
IP-адрес или имя хоста APIC, разрешаемый хостом Ansible.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_HOST.

псевдонимы: hostname
interface_profile
строка
Имя профиля интерфейса листа политики доступа к ткани.

псевдонимы: leaf_interface_profile_name, leaf_interface_profile, interface_profile_name
output_level
строка
    Варианты:
  • debug
  • info
  • normal ←
Влияет на вывод этого модуля ACI.
normal означает стандартный вывод, включая current словарь.
info добавляет информативный вывод, включая previous, proposed и sent словари.
debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_OUTPUT_LEVEL.
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.
port
целое число
Порт, используемый для подключения REST.
Значение по умолчанию зависит от параметра use_ssl.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_PORT.
port_blk
строка
Имя блока порта доступа профиля интерфейса листа политики доступа к ткани.

псевдонимы: leaf_port_blk_name, leaf_port_blk
port_blk_description
строка
Описание, которое нужно назначить leaf_port_blk.

псевдонимы: leaf_port_blk_description
private_key
строка
Файл приватного ключа в формате PEM или содержимое приватного ключа, используемого для аутентификации на основе подписи.
Это значение также влияет на значение по умолчанию certificate_name, которое используется.
Этот параметр является взаимоисключающим с password. Если также указан password, он будет проигнорирован.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_PRIVATE_KEY.

псевдонимы: cert_key
state
строка
    Варианты:
  • absent
  • present ←
  • query
Используйте present или absent для добавления или удаления.
Используйте query для перечисления объекта или нескольких объектов.
timeout
целое число
По умолчанию:
30
Таймаут на уровне сокета в секундах.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_TIMEOUT.
to_card
строка
Конечное значение (до-диапазон) диапазона карт для блока порта доступа листа.

псевдонимы: to_card_range
to_port
строка
Конечное значение (до-диапазон) диапазона портов для блока порта доступа листа.

псевдонимы: to, toPort, to_port_range
type
строка
    Варианты:
  • fex
  • leaf ←
Тип блока порта доступа, который будет создан под соответствующим портом доступа.
use_proxy
логическое
    Варианты:
  • no
  • yes ←
Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_USE_PROXY.
use_ssl
логическое
    Варианты:
  • no
  • yes ←
Если no, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_USE_SSL.
username
строка
По умолчанию:
"admin"
Имя пользователя для аутентификации.
Если значение не указано в задаче, будут использованы переменные окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

псевдонимы: user
validate_certs
логическое
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены.
Это должно быть установлено в no только при использовании на сайтах с самостоятельным управлением, использующих самозаверенные сертификаты.
Если значение не указано в задаче, будет использовано значение переменной окружения ACI_VALIDATE_CERTS.

Примечания

Примечание

  • Модули interface_profile и access_port_selector должны существовать перед использованием этого модуля в вашей книге задач. Модули cisco.aci.aci_interface_policy_leaf_profile и cisco.aci.aci_access_port_to_interface_policy_leaf_profile могут быть использованы для этого.

См. также

См. также

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

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

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

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

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

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

Примеры

- name: Associate an access 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 an access 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 an access 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 an access 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: Remove an access 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 an access 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

- name: Query Specific access 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 access 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 access 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 access 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 access 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 access 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

Значения возврата

Общие значения возврата описаны в здесь, следующие — поля, уникальные для этого модуля:

Ключ Возвращаемое значение Описание
current
список / элементы=строка
успех
Существующая конфигурация из APIC после завершения модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error
словарь
ошибка
Информация об ошибке, возвращённая APIC

Пример:
{'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string
строка
ошибка или отладка
Строка фильтра, используемая для запроса

Пример:
?rsp-prop-include=config-only
method
строка
ошибка или отладка
HTTP-метод, используемый для запроса к APIC

Пример:
POST
previous
список / элементы=строка
информация
Исходная конфигурация из APIC до запуска модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed
словарь
информация
Сформированная конфигурация из предоставленных пользователем параметров

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw
строка
ошибка парсинга
Необработанный вывод, возвращенный APIC REST API (xml или json)

Пример:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response
строка
ошибка или отладка
HTTP-ответ от APIC

Пример:
OK (30 байт)
sent
список / элементы=строка
информация
Фактическая/минимальная конфигурация, отправленная в APIC

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status
целое число
ошибка или отладка
HTTP-статус от APIC

Пример:
200
url
строка
ошибка или отладка
HTTP-URL, используемый для запроса к APIC

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


Авторы

  • Simon Metzger (@smnmtzgr)

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

Spec-Zone.ru

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