Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_esg – Управление объектами Групп безопасности конечных точек (ESGs) (fv:ESg)

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.aci.

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

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

Обзор

  • Управление группами безопасности конечных точек (ESGs) на Cisco ACI сетях.

Параметры

Параметр

Комментарии

admin_state

boolean

Используйте false для установки состояния «Admin Up» для ESG и это значение по умолчанию.

Используйте true для установки состояния «Admin Shut» для ESG.

Выбор:

  • false
  • true

annotation

string

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

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

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

По умолчанию: "orchestrator:ansible"

ap

псевдонимы: app_profile, app_profile_name

string

Имя профиля приложения.

certificate_name

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

string

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

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

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

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

description

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

string

Описание группы безопасности конечных точек.

esg

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

string

Имя группы безопасности конечных точек.

host

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

string

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

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

intra_esg_isolation

string

Значение по умолчанию для изоляции внутри ESG — unenforced.

Выбор:

  • "enforced"
  • "unenforced"

name_alias

string

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

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.

port

integer

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

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

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

preferred_group_member

string

Значение по умолчанию для Preferred Group Member — exclude.

Выбор:

  • "exclude"
  • "include"

private_key

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

string

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

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

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

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

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

tenant

aliases: tenant_name

string

Имя клиента.

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

vrf

aliases: vrf_name

string

Имя VRF.

См. также

См. также

cisco.aci.aci_aep_to_domain

Связать AEPs с физическими или виртуальными областями (infra:RsDomP).

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Add a new ESG
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    esg: web_esg
    vrf: 'default'
    description: Web Intranet ESG
    state: present
  delegate_to: localhost

- name: Add list of ESGs
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    esg: "{{ item.esg }}"
    description: Ticketing ESG
    vrf: 'default'
    state: present
  delegate_to: localhost
  with_items:
    - esg: web
    - esg: database

- name: Query an ESG
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    esg: web_esg
    state: query
  delegate_to: localhost

- name: Query all ESGs
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Query all ESGs with a Specific Name
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    esg: web_esg
    state: query
  delegate_to: localhost

- name: Query all ESGs of an App Profile
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    ap: ticketing
    state: query
  delegate_to: localhost

- name: Remove an ESG
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    app_profile: intranet
    esg: web_esg
    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"

Авторы

  • Сабари Джаганатан (@sajagana)

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

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

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

Spec-Zone.ru

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