cisco.aci.aci_cloud_ctx_profile – Управление профилем контекста облака (cloud:CtxProfile)

Примечание

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

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

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

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

Обзор

Управление объектами профилей контекста облака в Cisco Cloud ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
cloud строка	Варианты: aws azure	Поставщик облачных услуг, на котором работает контроллер.
description строка		Описание профиля контекста облака
host строка / обязательно		IP-адрес или имя хоста, разрешимые хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`. псевдонимы: hostname
name строка		Имя профиля контекста облака псевдонимы: cloud_context_profile
name_alias строка		Псевдоним для имени текущего объекта. Он относится к полю nameAlias в ACI и используется для переименования объекта без изменения DN.
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`.
primary_cidr строка		Подсеть с маской, используемая в качестве основного блока CIDR для профиля контекста облака.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимно исключается с `password`. Если также указано `password`, оно будет проигнорировано. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
region строка		Имя облачного региона, в котором необходимо развернуть сетевую конструкцию.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant строка		Имя арендатора.
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS подключения будет использоваться HTTP подключение. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при использовании на лично контролируемых сайтах с самозаверенными сертификатами. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.
vrf строка		Имя VRF.

Примечания

Примечание

Дополнительную информацию об внутреннем классе APIC cloud:CtxProfile можно найти в справочнике по модели управления информацией APIC.

См. также

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

Примеры

- name: Add a new aci cloud ctx profile
  cisco.aci.aci_cloud_ctx_profile:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: tenant_1
    name: cloud_ctx_profile
    vrf: VRF1
    region: us-west-1
    cloud: aws
    primary_cidr: '10.0.10.1/16'
    state: present
  delegate_to: localhost

- name: Remove an aci cloud ctx profile
  cisco.aci.aci_cloud_ctx_profile:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: tenant_1
    name: cloud_ctx_profile
    state: absent
  delegate_to: localhost

- name: Query a specific aci cloud ctx profile
  cisco.aci.aci_cloud_ctx_profile:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    name: ctx_profile_1
    state: query
  delegate_to: localhost

- name: Query all aci cloud ctx profile
  cisco.aci.aci_cloud_ctx_profile:
    host: apic_host
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    state: query
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Nirav (@crestdatasys)
Cindy Zhao (@cizhao)

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