Модуль cisco.aci.aci_management_network_instance_profile – управление профилями внешних экземпляров сети управления (mgmt:InstP).

Примечание

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

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

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

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

Добавлено в cisco.aci 2.13.0

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

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

Управление профилями внешних экземпляров сети управления в инфраструктуре Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче, а переменная среды `ACI_ANNOTATION` не задана, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, назначенного пользователю APIC AAA и используемого для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание профиля внешнего экземпляра сети управления.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level строка	Настройка вывода этого модуля ACI. `normal` — стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записываться JSON-объекты конфигурации ACI, созданные модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указано `private_key`, будет использовано именно оно. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name`, используемое по умолчанию. Этот параметр несовместим с `password`. Если также указано `password`, оно будет проигнорировано. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
profile псевдонимы: name, profile_name строка	Имя профиля внешнего экземпляра сети управления.
qos_class псевдонимы: qos, priority, prio строка	Идентификатор класса приоритета QoS. При создании объекта APIC использует значение `unspecified`, если параметр не задан. Варианты: `"level1"` `"level2"` `"level3"` `"level4"` `"level5"` `"level6"` `"unspecified"`
state строка	Для добавления или удаления используйте `present` или `absent`. Для получения списка одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
subnets псевдонимы: subnet_list, networks, network_list список / элементы=строка	Список подсетей в формате CIDR, связанных с профилем внешнего экземпляра сети управления. Если состояние равно `present` и указан список подсетей, все существующие подсети, отсутствующие в этом списке, будут удалены из объекта. Если для subnets задан пустой список, а состояние равно `present`, все существующие подсети будут удалены из профиля.
suppress_previous псевдонимы: no_previous, ignore_previous логический	Если `true`, перед отправкой POST-запроса на обновление в APIC не будет выполняться GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ. В результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверяться, а POST-запрос на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, после отправки POST-запроса на обновление в APIC не будет выполняться проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ. В результате возвращаемое значение current будет установлено в предложенное значение. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy логический	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl логический	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет применяться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs логический	Если `false`, SSL-сертификаты не будут проверяться. Устанавливайте значение `false` только на сайтах под личным управлением, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

Справочник по модели управляющей информации APIC: Дополнительные сведения о внутреннем классе APIC mgmt:InstP.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add a new external management network instance profile
  cisco.aci.aci_management_network_instance_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: lab_network_inst_profile
    subnets:
      - 10.20.30.0/24
      - 192.168.10.0/24
    state: present
  delegate_to: localhost

- name: Delete all subnets from management network instance profile
  cisco.aci.aci_management_network_instance_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: lab_network_inst_profile
    subnets: []
    state: present
  delegate_to: localhost

- name: Remove an external management network instance profile
  cisco.aci.aci_management_network_instance_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: lab_network_inst_profile
    state: absent
  delegate_to: localhost

- name: Query an external management network instance profile
  cisco.aci.aci_management_network_instance_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: lab_network_inst_profile
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all external management network instance profiles
  cisco.aci.aci_management_network_instance_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
current список / элементы=строка	Текущая конфигурация APIC после выполнения модуля Возвращается: success Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Сведения об ошибке, возвращённые APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Строка фильтра, использованная для запроса Возвращается: failure or debug Пример: `"?rsp-prop-include=config-only"`
method строка	Метод HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация APIC до начала выполнения модуля Возвращается: info Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собранная конфигурация на основе параметров, заданных пользователем Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод REST API APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	Ответ HTTP от APIC Возвращается: failure or debug Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, переданная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	Статус HTTP от APIC Возвращается: failure or debug Пример: `200`
url строка	URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Tim Cragg (@timcragg)

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

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