Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_l3out_interface_secondary_ip — управление вторичными IP-адресами интерфейсов Layer 3 Outside (L3Out) (l3ext:Ip)

Примечание

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

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

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

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

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

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

  • Управление вторичными IP-адресами интерфейсов Layer 3 Outside (L3Out).

Параметры

Параметр

Комментарии

address

псевдонимы: addr, ip_address

string

Вторичный IP-адрес.

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.

host

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

string

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

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

interface_profile

псевдонимы: interface_profile_name, logical_interface

string

Имя профиля интерфейса.

ipv6_dad

string

Функция IPv6 DAD.

Варианты:

  • "enabled"
  • "disabled"

l3out

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

string

Имя существующего L3Out.

node_id

string

Узел, на котором создаётся интерфейс для Port-channel и отдельных портов.

Пара узлов, разделённых дефисом (например, «201-202»), для vPC.

node_profile

псевдонимы: node_profile_name, logical_node

string

Имя профиля узла.

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.

password

string

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

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

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

path_ep

string

Путь к интерфейсу

Имя группы политик интерфейса для Port-channel и vPC

Номер порта для отдельных портов (например, «eth1/12»)

pod_id

string

Pod, на котором создаётся интерфейс.

port

integer

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

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

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

private_key

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

string

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

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

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

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

side

string

Задаёт сторону для интерфейсов-участников vPC.

Варианты:

  • "A"
  • "B"

state

string

Используйте present или absent для добавления или удаления.

Используйте query для получения списка одного или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

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

boolean

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

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

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

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

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

Варианты:

  • false
  • true

suppress_verification

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

boolean

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

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

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

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

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

Варианты:

  • false
  • true

tenant

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

string

Имя существующего арендатора.

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

См. также

См. также

cisco.aci.aci_l3out

Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).

cisco.aci.aci_l3out_logical_node_profile

Управление логическими профилями узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).

cisco.aci.aci_l3out_logical_interface_profile

Управление логическими профилями интерфейсов Layer 3 Outside (L3Out) (l3ext:LIfP).

cisco.aci.aci_l3out_logical_interface

Официальная документация по модулю cisco.aci.aci_l3out_logical_interface.

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

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

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

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

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

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

Примеры

- name: Add a new secondary IP to a routed interface
  cisco.aci.aci_l3out_interface_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    address: 192.168.10.2/27
    state: present
  delegate_to: localhost

- name: Add a new secondary IP to a vPC member
  cisco.aci.aci_l3out_interface_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201-202
    path_ep: my_vpc_ipg
    side: A
    address: 192.168.10.2/27
    state: present
  delegate_to: localhost

- name: Delete a secondary IP
  cisco.aci.aci_l3out_interface_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    address: 192.168.10.2/27
    state: absent
  delegate_to: localhost

- name: Query a secondary IP
  cisco.aci.aci_l3out_interface_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    address: 192.168.10.2/27
    state: query
  delegate_to: localhost
  register: query_result

Возвращаемые значения

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

Ключ

Описание

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: успех

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращённые APIC

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

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: при сбое или в режиме отладки

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

method

string

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

Возвращается: при сбое или в режиме отладки

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

Возвращается: сведения

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, указанных пользователем

Возвращается: сведения

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

raw

string

Необработанный вывод, возвращённый REST API APIC (xml или json)

Возвращается: ошибка разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: при сбое или в режиме отладки

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

sent

list / elements=string

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

Возвращается: сведения

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

status

integer

Статус HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: 200

url

string

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

Возвращается: при сбое или в режиме отладки

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

Авторы

  • Marcel Zehnder (@maercu)

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

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

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

Spec-Zone.ru

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