Модуль cisco.aci.aci_cloud_vpn_gateway – Управление cloudRouterP в профиле облачного контекста (cloud:RouterP)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в книге задач укажите: cisco.aci.aci_cloud_vpn_gateway.
Описание
- Управление объектами cloudRouterP в Cisco Cloud ACI.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Если значение не указано в задаче и переменной окружения Default: |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
cloud_context_profile string / required | Имя профиля контекста облака. |
host aliases: hostname string | IP-адрес или имя хоста APIC, распознаваемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Choices:
|
output_path string | Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
owner_key string | Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
owner_tag string | Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
password string | Пароль для аутентификации. Этот параметр является взаимоисключающим с Если значение не указано в задаче, вместо него будут использованы значения переменных окружения |
port integer | Номер порта, который будет использоваться для соединения REST. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
private_key aliases: cert_key string | Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр является взаимоисключающим с Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
state string | Используйте Используйте Choices:
|
suppress_previous aliases: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Choices:
|
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное. Текущий объект, включая значения по умолчанию, будет не проверяемым в одной задаче. Варианты:
|
tenant string / обязательно | Имя тенанта. |
timeout целое число | Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true, когда соединение локальное. Варианты:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды Значение по умолчанию — admin. |
validate_certs boolean | Если Это следует установить в Если значение не указано в задаче, будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
Примечания
Примечание
- Дополнительная информация об внутреннем классе APIC cloud:RouterP из справочника модели управления информацией APIC.
См. также
См. также
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Enable VpnGateway
cisco.aci.aci_cloud_vpn_gateway:
host: apic_host
username: admin
password: SomeSecretPassword
tenant: ansible_test
cloud_context_profile: ctx_profile_1
state: present
delegate_to: localhost
- name: Disable VpnGateway
cisco.aci.aci_cloud_vpn_gateway:
host: apic_host
username: admin
password: SomeSecretPassword
tenant: ansible_test
cloud_context_profile: ctx_profile_1
state: absent
delegate_to: localhost
- name: Query VpnGateway
cisco.aci.aci_cloud_vpn_gateway:
host: apic_host
username: admin
password: SomeSecretPassword
tenant: ansible_test
cloud_context_profile: ctx_profile_1
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Существующая конфигурация из APIC после завершения модуля Возвращено: успех Пример: |
error словарь | Информация об ошибке, возвращённая из APIC Возвращено: ошибка Пример: |
filter_string строка | Строка фильтра, использованная для запроса Возвращено: ошибка или отладка Пример: |
method строка | HTTP-метод, использованный для запроса к APIC Возвращено: ошибка или отладка Пример: |
previous список / элементы=строка | Исходная конфигурация из APIC до запуска модуля Возвращено: информация Пример: |
proposed словарь | Собраная конфигурация из параметров пользователя Возвращено: информация Пример: |
raw строка | Необработанный вывод, возвращённый API REST APIC (xml или json) Возвращено: ошибка разбора Пример: |
response строка | HTTP-ответ от APIC Возвращено: ошибка или отладка Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: |
status целое число | HTTP-статус от APIC Возвращено: ошибка или отладка Пример: |
url строка | HTTP-URL, использованный для запроса к APIC Возвращено: ошибка или отладка Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_cloud_vpn_gateway_module.html