Модуль cisco.aci.aci_cloud_region – Управление облачными провайдерами региона (облако:Регион)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать его в плейбуке, укажите: cisco.aci.aci_cloud_region.
Обзор
- Управление облачными провайдерами региона в Cisco Cloud ACI.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Строка, определяемая пользователем, для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Если значение не указано в задаче и переменной среды Default: |
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
cloud string / required | Поставщик контроллера Choices:
|
host aliases: hostname string | IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды Choices:
|
output_path string | Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
password string | Пароль для аутентификации. Этот параметр взаимоисключающий с Если значение не указано в задаче, вместо него будут использованы значения переменных среды |
port integer | Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
private_key aliases: cert_key string | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр взаимоисключающий с Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
region aliases: name string | Имя региона поставщика облачных услуг. |
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 | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию - ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет непроверяем в одной задаче. Choices:
|
timeout integer | Время ожидания на уровне сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию — true для локального подключения. Варианты:
|
username aliases: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения Значение по умолчанию — admin. |
validate_certs boolean | Если Это следует устанавливать в Если значение не указано в задаче, будет использовано значение переменной окружения Значение по умолчанию — true. Варианты:
|
Примечания
Примечание
- Дополнительная информация об внутреннем классе APIC cloud:Region из справочника по модели управления информацией APIC.
- Этот модуль используется для запроса облачных поставщиков региона.
См. также
См. также
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для участия.
Примеры
- name: Query all regions
cisco.aci.aci_cloud_region:
host: apic
username: userName
password: somePassword
validate_certs: false
cloud: 'aws'
state: query
delegate_to: localhost
- name: Query a specific region
cisco.aci.aci_cloud_region:
host: apic
username: userName
password: somePassword
validate_certs: false
cloud: 'aws'
region: eu-west-2
state: query
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_region_module.html