Spec-Zone.ru › Ansible 2.11

cisco.aci.aci_cloud_cidr – Управление CIDR в профиле контекста облака (cloud:Cidr)

Примечание

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

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

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

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

Обзор

  • Управление облачным CIDR в Cisco Cloud ACI.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
строка
CIDR ip и его маска сети.

псевдонимы: cidr
annotation
строка
Пользовательская строка для аннотации объекта.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_ANNOTATION
certificate_name
строка
Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.
Если предоставлено имя файла private_key, по умолчанию используется имя файла private_key, без расширения.
Если предоставлено содержимое в формате PEM для private_key, по умолчанию используется значение username
Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_CERTIFICATE_NAME

псевдонимы: cert_name
cloud_context_profile
строка / обязательно
Имя профиля контекста облака.
description
строка
Описание облачного CIDR.
host
строка / обязательно
IP-адрес или имя хоста APIC, разрешимые хостом Ansible.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_HOST

псевдонимы: hostname
name_alias
строка
Псевдоним для имени текущего объекта. Это относится к полю nameAlias в ACI и используется для переименования объекта без изменения DN.
output_level
строка
    Варианты:
  • debug
  • info
  • normal ←
Влияет на вывод этого модуля ACI.
normal означает стандартный вывод, вкл. current dict
info добавляет информативный вывод, вкл. previous, proposed и sent dicts
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
private_key
строка
Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи.
Это значение также влияет на значение по умолчанию certificate_name, которое используется.
Этот параметр исключает password. Если также предоставлен password, он будет проигнорирован.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PRIVATE_KEY

псевдонимы: cert_key
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

Примечания

Примечание

  • Этот модуль используется только для управления не-первичными облачными CIDR, см. cisco.aci.aci_cloud_ctx_profile для создания первичного CIDR.
  • Дополнительную информацию об внутреннем классе APIC cloud:Cidr из справочника по модели управления информацией APIC.

См. также

См. также

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

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

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

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

Примеры

- name: Create non_primary CIDR
  cisco.aci.aci_cloud_cidr:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: tenantName
    address: 10.10.0.0/16
    cloud_context_profile: ctxProfileName
    state: present
  delegate_to: localhost

- name: Remove non_primary CIDR
  cisco.aci.aci_cloud_cidr:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: tenantName
    address: 10.10.0.0/16
    cloud_context_profile: ctxProfileName
    state: absent
  delegate_to: localhost

- name: Query all CIDRs under given cloud context profile
  cisco.aci.aci_cloud_cidr:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: tenantName
    cloud_context_profile: ctxProfileName
    state: query
  delegate_to: localhost

- name: Query specific CIDR under given cloud context profile
  cisco.aci.aci_cloud_cidr:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: tenantName
    cloud_context_profile: ctxProfileName
    address: 10.10.0.0/16
    state: query
  delegate_to: localhost

Значения возврата

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

Ключ Возвращаемое значение Описание
current
список / элементы=строка
успех
Текущая конфигурация с APIC после завершения модуля

Пример:
[{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'производство', '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': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed
словарь
информация
Собраная конфигурация из параметров пользователя

Пример:
{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'производство'}}}
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-url, используемый для запроса к APIC

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


Авторы

  • Nirav (@nirav)
  • 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_cidr_module.html

Spec-Zone.ru

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