Spec-Zone.ru › Ansible 2.11

cisco.aci.aci_cloud_subnet – Управление облачной подсетью (облако:Подсеть)

Примечание

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

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

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

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

Обзор

  • Управление облачной подсетью в Cisco Cloud ACI.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
строка
IP-адрес облачной подсети.

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

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

псевдонимы: hostname
name
строка
Имя облачной подсети.
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.
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, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.
Если значение не указано в задаче, используется значение переменной окружения ACI_USE_SSL.
username
строка
По умолчанию:
"admin"
Имя пользователя для аутентификации.
Если значение не указано в задаче, используется значение переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

псевдонимы: user
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены.
Это должно быть установлено на no только при работе с сайтами под собственным контролем, использующими самоподписанные сертификаты.
Если значение не указано в задаче, используется значение переменной окружения ACI_VALIDATE_CERTS.
vnet_gateway
булево
    Варианты:
  • no
  • yes
Определяет, будет ли развернут маршрутизатор vNet Gateway.
Используется только при работе с облачной APIC Azure.

Примечания

Примечание

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

См. также

См. также

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

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

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

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

Примеры

- name: Create aci cloud subnet
  cisco.aci.aci_cloud_subnet:
    host: apic
    username: userName
    password: somePassword
    validate_certs: no
    tenant: anstest
    cloud_context_profile: aws_cloudCtxProfile
    cidr: '10.10.0.0/16'
    availability_zone: us-west-1a
    address: 10.10.0.1
  delegate_to: localhost

- name: Query a specific subnet
  cisco.aci.aci_cloud_subnet:
    host: apic
    username: userName
    password: somePassword
    validate_certs: no
    tenant: anstest
    cloud_context_profile: ctx_profile_1
    cidr: '10.10.0.0/16'
    address: 10.10.0.1
    state: query
  delegate_to: localhost

- name: Query all subnets
  cisco.aci.aci_cloud_subnet:
    host: apic
    username: userName
    password: somePassword
    validate_certs: no
    tenant: anstest
    cloud_context_profile: ctx_profile_1
    cidr: '10.10.0.0/16'
    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 (@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_subnet_module.html

Spec-Zone.ru

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