Модуль cisco.dnac.site_update — Модуль ресурса для обновления сайта

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

Управление обновлением ресурса «Обновление сайта».
Обновление области/здания/этажа сайта с указанной иерархией и новыми значениями.

Примечание

Этот модуль имеет соответствующий плагин действия.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK, чтобы включить отладку. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
site словарь	Сайт обновления сайта.
area словарь	Область обновления сайта.
name строка	Имя области.
parentName строка	Иерархическое имя родителя (например, Global/USA/CA).
building словарь	Здание обновления сайта.
address строка	Адрес здания (например, 4900 Marie P. Debartolo Way, Santa Clara, California 95054, Соединенные Штаты).
country строка	Название страны. Это поле обязательно для изолированных сетей (например, Соединенные Штаты).
latitude вещественное число	Широта здания (например, 37.403712).
longitude вещественное число	Долгота здания (например, -121.971063).
name строка	Название здания.
parentName строка	Иерархическое имя родителя (например, Global/USA/CA/SantaClara).
floor словарь	Этаж обновления сайта.
floorNumber вещественное число	Номер этажа (например, 3).
height вещественное число	Высота этажа в футах (например, 10).
length вещественное число	Длина этажа в футах (например, 100).
name строка	Название этажа.
rfModel строка	Модель РЧ (например, Cubes And Walled Offices).
width вещественное число	Ширина этажа в футах (например, 200).

siteId string	Параметр пути siteId. Идентификатор сайта, для которого необходимо обновить данные о сайте.
type string	Тип сайта.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, который включает валидацию тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center по обновлению сайта (UpdateSite): Полное описание API UpdateSite.

Примеры

- name: Update by id
  cisco.dnac.site_update:
    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}}"
    headers: '{{my_headers | from_json}}'
    site:
      area:
        name: string
        parentName: string
      building:
        address: string
        country: string
        latitude: 0
        longitude: 0
        name: string
        parentName: string
      floor:
        floorNumber: 0
        height: 0
        length: 0
        name: string
        rfModel: string
        width: 0
    siteId: string
    type: string

Возвращаемые значения

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

Ключ	Описание
dnac_response словарь	Словарь или список, содержащий ответ, возвращенный Cisco DNAC Python SDK Возвращается: всегда Пример: `{"response": {"data": "string", "endTime": "string", "id": "string", "instanceTenantId": "string", "isError": "string", "operationIdList": ["string"], "progress": "string", "rootId": "string", "serviceType": "string", "startTime": "string", "version": "string"}, "result": "string", "status": "string"}`

Ключ

Описание

dnac_response

словарь

Словарь или список, содержащий ответ, возвращенный Cisco DNAC Python SDK

Возвращается: всегда

Пример: {"response": {"data": "string", "endTime": "string", "id": "string", "instanceTenantId": "string", "isError": "string", "operationIdList": ["string"], "progress": "string", "rootId": "string", "serviceType": "string", "startTime": "string", "version": "string"}, "result": "string", "status": "string"}

Авторы

Rafael Campos (@racampos)

Ссылки на сборки

© 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_update_module.html