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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.site_workflow_manager.

Добавлена в 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` ← (default) `true`

dnac_api_task_timeout integer	Определяет время ожидания в секундах для вызовов API для получения сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания. Default: `1200`
dnac_debug boolean	Указывает, включена ли отладка в Cisco Catalyst Center SDK. Choices: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco Catalyst Center.
dnac_log boolean	Флаг для включения/отключения ведения журнала выполнения playbook. Если true и указан dnac_log_file_path, - Создает файл журнала в местоположении выполнения с указанным именем. Если true и dnac_log_file_path не указан, - Создает файл журнала в местоположении выполнения с именем ‘dnac.log’. Если false, - Ведение журнала отключено. Если файл журнала не существует, - Он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”. Если файл журнала существует, - Он перезаписывается или дополняется в зависимости от флага “dnac_log_append”. Choices: `false` ← (default) `true`
dnac_log_append boolean	Определяет режим файла. Установите значение True для режима «добавить». Установите значение False для режима «запись». Choices: `false` `true` ← (default)
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). - В сценариях с общим файлом без режима добавления содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите append в False для первого модуля (для перезаписи); для последующих модулей установите append в True. Default: `"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 предоставляет подробную диагностическую информацию. Отображает все сообщения журнала. Default: `"WARNING"`
dnac_password string	Пароль для аутентификации в Cisco Catalyst Center.
dnac_port string	Указывает номер порта, связанного с Cisco Catalyst Center. Default: `"443"`
dnac_task_poll_interval integer	Указывает интервал в секундах между последовательными вызовами API для получения сведений о задаче. Default: `2`
dnac_username aliases: user string	Имя пользователя для аутентификации в Cisco Catalyst Center. Default: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Choices: `false` `true` ← (default)
dnac_version string	Указывает версию Cisco Catalyst Center, которую должен использовать SDK. Default: `"2.2.3.3"`
state string	Состояние Catalyst Center после завершения работы модуля. Choices: `"merged"` ← (default) `"deleted"`
validate_response_schema boolean	Флаг для Cisco Catalyst Center SDK для включения проверки тел запросов на соответствие схеме JSON. Choices: `false` `true` ← (default)

Примечания

Примечание

Используемые методы 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 Catalyst Center SDK
Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения

Примеры

- name: Create a new area site
  cisco.dnac.site_workflow_manager:
    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_workflow_manager:
    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_workflow_manager:
    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_workflow_manager:
    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_workflow_manager:
    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, возвращёнными Cisco Catalyst Center Python SDK Возвращается: всегда Пример: "{\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, возвращёнными Cisco Catalyst Center Python SDK Возвращается: всегда Пример: "{\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 список / элементы=строка	Список с ответом, возвращённым Cisco Catalyst Center Python Возвращается: всегда Пример: `["{\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_workflow_manager_module.html