Spec-Zone.ru › Ansible 2.10

cisco.aci.aci_cloud_subnet – Управление облачным подсетью (cloud:Subnet)

Примечание

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

Для его установки используйте: 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
строка
Путь к файлу, который будет использоваться для вывода JSON-конфигурации объектов ACI, сгенерированных модулем.
Если значение не указано в задаче, используется значение переменной окружения 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.
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': 'производство', '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
строка
ошибка разбора
Необработанный вывод, возвращённый REST API APIC (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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_cloud_subnet_module.html

Spec-Zone.ru

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