Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_epg_subnet – Управление подсетями EPG (fv:Subnet)

Примечание

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

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

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

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

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

Описание

  • Управление подсетями EPG на тканях Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

Пользовательская строка для аннотации объекта.

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

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

Default: "orchestrator:ansible"

ap

aliases: app_profile, app_profile_name

string

Имя существующего профиля сети приложений, который будет содержать EPG.

certificate_name

aliases: cert_name

string

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

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

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

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

description

aliases: descr

string

Описание подсети.

enable_vip

boolean

Определяет, следует ли рассматривать подсеть как VIP (виртуальный IP-адрес).

APIC использует значение по умолчанию false при отсутствии значения во время создания.

Choices:

  • false
  • true

epg

aliases: epg_name

string

Имя группы конечных точек.

gateway

aliases: gateway_ip

string

IPv4 или IPv6 адрес шлюза для подсети.

host

aliases: hostname

string

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

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

ip_data_plane_learning

aliases: ip_dataplane_learning

string

Включено или выключено обучение в плоскости данных IP.

APIC использует значение по умолчанию enabled при отсутствии значения во время создания.

Choices:

  • "enabled"
  • "disabled"

mask

aliases: subnet_mask

integer

Маска подсети.

Это число, связанное с нотацией CIDR.

Для IPv4-адресов допустимые значения находятся в диапазоне от 0 до 32.

Для IPv6-адресов допустимые значения находятся в диапазоне от 0 до 128.

name_alias

string

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

nd_prefix_policy

string

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

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.

password

string

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

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

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

port

integer

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

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

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

preferred

boolean

Определяет, является ли подсеть предпочтительной по отношению ко всем доступным подсетям. Только одна подсеть на семейство адресов (IPv4/IPv6) может быть предпочтительной в домене моста.

APIC по умолчанию использует значение false при создании, если параметр не задан.

Варианты:

  • false
  • true

private_key

aliases: cert_key

string

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

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

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

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

route_profile

string

Профиль маршрутизации для ассоциации с подсетью.

route_profile_l3out

string

L3Out, содержащий связанный профиль маршрутизации.

scope

list / elements=string

Определяет область действия подсети.

Вариант private позволяет обмениваться данными только с узлами в том же VRF.

Вариант public позволяет рекламировать подсеть за пределами ACI Fabric и обмениваться данными с узлами в других VRF.

Вариант shared ограничивает обмен данными узлами в том же VRF или в shared VRF.

Значение представляет собой список вариантов, private и public взаимоисключающие, но оба могут быть использованы с shared.

APIC по умолчанию использует значение private при создании, если параметр не задан.

Варианты:

  • "private"
  • "public"
  • "shared"

state

string

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

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

Варианты:

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

subnet_control

string

Определяет состояние управления подсетью.

Вариант querier_ip используется для обработки gateway_ip как исходного IP-адреса запроса IGMP.

Вариант nd_ra используется для обработки адреса gateway_ip как префикса маршрутизации Neighbor Discovery Router Advertisement.

Вариант no_gw используется для удаления функции шлюза по умолчанию из адреса шлюза.

APIC по умолчанию использует значение nd_ra при создании, если параметр не задан.

Варианты:

  • "nd_ra_prefix"
  • "no_default_gateway"
  • "querier_ip"
  • "unspecified"

subnet_name

aliases: name

string

Имя подсети.

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

tenant

aliases: 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

имя_пользователя

псевдонимы: пользователь

строка

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

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

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

validate_certs

булево

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

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

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

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

Варианты:

  • false
  • true

Примечания

Примечание

  • Параметр gateway — это корневой ключ доступа к подсети (не имя), поэтому gateway требуется, когда состояние равно absent или present.
  • Переменные tenant, ap и epg должны существовать до использования этого модуля в вашей книге задач. Модули cisco.aci.aci_tenant, cisco.aci.aci_ap и cisco.aci.aci_epg могут быть использованы для этого.

См. также

См. также

cisco.aci.aci_epg

Управление объектами групп конечных точек (EPG) (fv:AEPg).

cisco.aci.aci_ap

Управление объектами профиля приложения верхнего уровня (AP) (fv:Ap).

cisco.aci.aci_tenant

Управление арендаторами (fv:Tenant).

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Create a subnet
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    state: present
  delegate_to: localhost

- name: Create a subnet with options
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    subnet_name: sql
    gateway: 10.1.2.1
    mask: 23
    description: SQL Servers
    scope: public
    route_profile_l3out: corp
    route_profile: corp_route_profile
    state: present
  delegate_to: localhost

- name: Update a subnets scope to private and shared
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    scope: [private, shared]
    state: present
  delegate_to: localhost

- name: Get all subnets
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Get all subnets of specific gateway in specified tenant
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Get specific subnet
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a subnet
  cisco.aci.aci_epg_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    gateway: 10.1.1.1
    mask: 24
    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_epg_subnet_module.html

Spec-Zone.ru

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