cisco.dnac.site_intent модуль — Модуль ресурсов для операций с сайтами

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуется дополнительное обеспечение, см. Требования для получения подробностей.

Для использования в плейбуке укажите: cisco.dnac.site_intent.

Новое в cisco.dnac 6.6.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Управление операциями создания, обновления и удаления ресурсов сайтов.
Создание сайта с областью/зданием/этажом со заданной иерархией.
Обновление сайта с областью/зданием/этажом со заданной иерархией.
Удаление сайта с областью/зданием/этажом со заданной иерархией.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

dnacentersdk == 2.4.5
python >= 3.9

Параметры

Параметр	Комментарии
config list / elements=dictionary / required	Представляет собой список подробных сведений для создания/управления/удаления сайтов, включая зоны, здания и этажи.
site dictionary	Содержит подробные сведения об управляемом сайте, включая зоны, здания и этажи.
area dictionary	Параметры конфигурации для создания или управления зоной на сайте.
name string	Имя зоны, которая будет создана или изменена (например, «Area1»).
parent_name string	Полное имя родительского элемента, под которым будет создана/управляется/удалена зона (например, «Global/USA»).
building dictionary	Параметры конфигурации, необходимые для создания или управления зданием на сайте.
address string	Физический адрес здания, которое будет создано или изменено.
latitude float	Географическая широта здания. Например, используйте 37.338 для местоположения в Сан-Хосе, Калифорния. Допустимые значения находятся в диапазоне от -90,0 до +90,0 градусов.
longitude float	Географическая долгота здания. Например, используйте -121.832 для местоположения в Сан-Хосе, Калифорния. Допустимые значения находятся в диапазоне от -180,0 до +180,0 градусов.
name string	Имя здания (например, «Building1»).
parent_name string	Иерархический путь родительского элемента здания, указывающий его местоположение на сайте (например, «Global/USA/San Francisco»).
floor dictionary	Параметры конфигурации, необходимые для создания или управления этажом на сайте.
floor_number integer	Номер этажа на сайте (например, 5). Это значение можно указать только при создании этажа и его нельзя изменить позже.
height float	Высота этажа в футах (например, 15.23).
length float	Длина этажа в футах (например, 100.11).
name string	Имя этажа (например, «Floor-1»).
parent_name string	Иерархический путь родительского элемента этажа, указывающий его местоположение на сайте (например, «Global/USA/San Francisco/BGL_18»).
rf_model string	Тип модели радиочастоты (RF) для этажа, что важно для моделирования и оптимизации покрытия беспроводной сети. Выберите одно из следующих допустимых значений, которые описывают различные характеристики распространения сигнала в окружающей среде. Тип этажа (допустимые значения: ‘Cubes And Walled Offices’, ‘Drywall Office Only’, ‘Indoor High Ceiling’, ‘Outdoor Open Space’). Cubes And Walled Offices - Эта модель RF обычно представляет собой внутренние помещения с кабинами или стенами, где радиосигналы могут испытывать затухание из-за стен и препятствий. Drywall Office Only - Эта модель RF указывает на среду с перегородками из гипсокартона, обычно встречающимися в офисных помещениях, где может наблюдаться умеренное затухание сигнала. Indoor High Ceiling - Эта модель RF подходит для внутренних помещений с высокими потолками, таких как аудитории или атриумы, где распространение сигнала может отличаться из-за высоты потолка. Outdoor Open Space - Эта модель RF используется для открытых площадок, где распространение сигнала менее загромождено и может следовать другим шаблонам по сравнению с внутренними помещениями.
width float	Ширина этажа в футах (например, 100.22).
site_type string	Тип сайта для создания/обновления/удаления (например, зона, здание, этаж).
config_verify boolean	Установите в True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook. Варианты: `false` ← (по умолчанию) `true`
dnac_api_task_timeout integer	Определяет время ожидания в секундах для вызовов API для получения сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания. По умолчанию: `1200`

dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_log boolean	Флаг для включения/выключения ведения журнала выполнения playbook. Когда значение true и указан dnac_log_file_path, - Создать файл журнала в местоположении выполнения с указанным именем. Когда значение true и dnac_log_file_path не указан, - Создать файл журнала в местоположении выполнения с именем ‘dnac.log’. Когда значение false, - Ведение журнала отключено. Если файла журнала не существует, - Он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”. Если файл журнала существует, - Он перезаписывается или дополняется в зависимости от флага “dnac_log_append”. Варианты: `false` ← (по умолчанию) `true`
dnac_log_append boolean	Определяет режим файла. Установить в True для режима ‘добавления’. Установить в False для режима ‘записи’. Варианты: `false` `true` ← (по умолчанию)
dnac_log_file_path string	Управляет ведением журнала. Журналы записываются, если dnac_log имеет значение True. Если путь не указан, - Когда ‘dnac_log_append’ равно True, ‘dnac.log’ генерируется в текущем каталоге Ansible; журналы добавляются. - Когда ‘dnac_log_append’ равно False, ‘dnac.log’ генерируется; журналы перезаписываются. Если путь указан, - Когда ‘dnac_log_append’ равно True, файл открывается в режиме добавления. - Когда ‘dnac_log_append’ равно False, файл открывается в режиме записи (w). - В сценариях с общим файлом, без режима добавления, содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите добавление в False для первого модуля (для перезаписи); для последующих модулей установите добавление в True. По умолчанию: `"dnac.log"`
dnac_log_level string	Устанавливает порог уровня журнала. Сообщения с уровнем, равным или превышающим этот уровень, будут записаны в журнал. Уровни указаны в порядке ухудшения [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL указывает серьезные ошибки, останавливающие программу. Отображаются только сообщения CRITICAL. ERROR указывает проблемы, препятствующие работе функции. Отображаются сообщения ERROR и CRITICAL. WARNING указывает возможные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL. INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL. DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала. По умолчанию: `"WARNING"`
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port string	Порт Cisco DNA Center. По умолчанию: `"443"`
dnac_task_poll_interval integer	Указывает интервал в секундах между последовательными вызовами API для получения подробностей о задаче. По умолчанию: `2`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.2.3.3"`
state string	Состояние Catalyst Center после завершения модуля. Варианты: `"merged"` ← (по умолчанию) `"deleted"`
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: sites.Sites.create_site, sites.Sites.update_site, sites.Sites.delete_site
Используемые пути: post /dna/intent/api/v1/site, put dna/intent/api/v1/site/{siteId}, delete dna/intent/api/v1/site/{siteId}
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

Примеры

- name: Create a new area site
  cisco.dnac.site_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        area:
          name: Test
          parent_name: Global/India
      site_type: area

- name: Create a new building site
  cisco.dnac.site_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        building:
          name: Building_1
          parent_name: Global/India
          address: Bengaluru, Karnataka, India
          latitude: 24.12
          longitude: 23.45
      site_type: building

- name: Create a Floor site under the building
  cisco.dnac.site_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        floor:
          name: Floor_1
          parent_name: Global/India/Building_1
          length: 75.76
          width: 35.54
          height: 30.12
          rf_model: Cubes And Walled Offices
          floor_number: 2
      site_type: floor

- name: Updating the Floor details under the building
  cisco.dnac.site_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        floor:
          name: Floor_1
          parent_name: Global/India/Building_1
          length: 75.76
          width: 35.54
          height: 30.12
      site_type: floor

- name: Deleting any site you need site name and parent name
  cisco.dnac.site_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: deleted
    config:
    - site:
        floor:
          name: Floor_1
          parent_name: Global/India/Building_1
      site_type: floor

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

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

Ключ	Описание
response_1 словарь	Словарь с деталями выполнения API, возвращёнными Python SDK Cisco Catalyst Center. Возвращается: всегда Пример: "{\n \"response\":\n {\n \"bapiExecutionId\": String,\n \"bapiKey\": String,\n \"bapiName\": String,\n \"endTime\": String,\n \"endTimeEpoch\": 0,\n \"runtimeInstanceId\": String,\n \"siteId\": String,\n \"startTime\": String,\n \"startTimeEpoch\": 0,\n \"status\": String,\n \"timeDuration\": 0\n\n },\n \"msg\": \"string\"\n}\n"
response_2 словарь	Словарь с существующими данными о сайте. Возвращается: всегда Пример: `"{\n \"response\":\n {\n \"site\": {},\n \"siteId\": String,\n \"type\": String\n },\n \"msg\": String\n}\n"`
response_3 словарь	Словарь с деталями выполнения API, возвращёнными Python SDK Cisco Catalyst Center. Возвращается: всегда Пример: "{\n \"response\":\n {\n \"bapiError\": String,\n \"bapiExecutionId\": String,\n \"bapiKey\": String,\n \"bapiName\": String,\n \"endTime\": String,\n \"endTimeEpoch\": 0,\n \"runtimeInstanceId\": String,\n \"startTime\": String,\n \"startTimeEpoch\": 0,\n \"status\": String,\n \"timeDuration\": 0\n\n },\n \"msg\": \"string\"\n}\n"
response_4 список / элементы=строка	Список с ответом, возвращённым Python SDK Cisco Catalyst Center. Возвращается: всегда Пример: `["{\n \"response\": []", "\n \"msg\": String\n}\n"]`

Авторы

Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) Abhishek Maheshwari (@abhishekmaheshwari)

Ссылки на коллекцию

© 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/dnac/site_intent_module.html