Spec-Zone.ru › Ansible

Модуль cisco.dnac.planned_access_points – Модуль ресурсов для запланированных точек доступа

Примечание

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

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

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

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

Новый в cisco.dnac 6.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Обзор

  • Управление операциями создания, обновления и удаления ресурсов «Запланированные точки доступа».
  • Позволяет создать новую запланированную точку доступа на существующей карте этажа, включая запланированные радиомодули и антенны. Используйте вариант «Получить» этого API, чтобы получить все существующие запланированные точки доступа для этажа. Данные для создания запланированной точки доступа имеют тот же формат, что и для API, но в виде одного объекта вместо списка.
  • Позволяет удалить запланированную точку доступа с существующей карты этажа, включая запланированные радиомодули и антенны. Используйте вариант «Получить» этого API, чтобы получить существующие запланированные точки доступа для этажа. Значение instanceUUID, указанное в каждом атрибуте запланированной точки доступа, используется как параметр пути для этого API для удаления конкретной записи.
  • Позволяет обновить запланированную точку доступа на существующей карте этажа, включая запланированные радиомодули и антенны. Используйте вариант «Получить» этого API, чтобы получить существующие запланированные точки доступа для этажа. Данные для обновления запланированной точки доступа имеют тот же формат, что и для API, но в виде одного объекта вместо списка.

Примечание

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

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

attributes

словарь

Атрибуты запланированных точек доступа.

createDate

целое число

createDate запланированных точек доступа.

domain

строка

Домен запланированных точек доступа.

heirarchyName

строка

heirarchyName запланированных точек доступа.

id

вещественное число

id запланированных точек доступа.

instanceUuid

строка

instanceUuid запланированных точек доступа.

macaddress

строка

macaddress запланированных точек доступа.

name

строка

Название запланированных точек доступа.

source

строка

Источник запланированных точек доступа.

typeString

строка

typeString запланированных точек доступа.

dnac_debug

логическое значение

Флаг для включения отладки в SDK Cisco DNA Center.

Варианты:

  • 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

логическое значение

Флаг для включения или выключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (по умолчанию)

dnac_version

строка

Указывает SDK, какую версию Cisco DNA Center использовать.

По умолчанию: "2.3.7.6"

floorId

строка

Параметр пути floorId. UUID экземпляра элемента иерархии этажа.

isSensor

логическое значение

Флаг isSensor.

Варианты:

  • false
  • true

location

словарь

Расположение запланированных точек доступа.

altitude

вещественное число

Высота запланированных точек доступа.

lattitude

вещественное число

Широта запланированных точек доступа.

longtitude

вещественное число

Долгота запланированных точек доступа.

plannedAccessPointUuid

строка

Параметр пути plannedAccessPointUuid. UUID экземпляра запланированной точки доступа для удаления.

position

словарь

Позиция запланированных точек доступа.

x

float

Координата x точки доступа.

y

float

Координата y точки доступа.

z

float

Координата z точки доступа.

radioCount

integer

Количество радиочастотных каналов точки доступа.

radios

list / elements=dictionary

Характеристики радиочастотных каналов точки доступа.

antenna

dictionary

Параметры антенны.

azimuthAngle

float

Угол азимута антенны.

elevationAngle

float

Угол возвышения антенны.

gain

float

Усиление антенны.

mode

string

Режим работы антенны.

name

string

Имя антенны.

type

string

Тип антенны.

attributes

dictionary

Атрибуты радиочастотного канала.

channel

float

Номер канала.

channelString

string

Строковое представление номера канала.

id

float

Идентификатор.

ifMode

string

Режим интерфейса.

ifTypeString

string

Строковое представление типа интерфейса.

ifTypeSubband

string

Поддиапазон типа интерфейса.

instanceUuid

string

Уникальный идентификатор экземпляра.

slotId

float

Идентификатор слота.

isSensor

boolean

Флаг датчика.

Варианты:

  • false
  • true

validate_response_schema

boolean

Флаг для включения валидации ответов Cisco DNA Center SDK на соответствие JSON схеме.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Используемые методы SDK: devices.Devices.create_planned_access_point_for_floor, devices.Devices.delete_planned_access_point_for_floor, devices.Devices.update_planned_access_point_for_floor,
  • Используемые пути: post /dna/intent/api/v1/floors/{floorId}/planned-access-points, delete /dna/intent/api/v1/floors/{floorId}/planned-access-points/{plannedAccessPointUuid}, put /dna/intent/api/v1/floors/{floorId}/planned-access-points,
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco DNA Center по Devices CreatePlannedAccessPointForFloor

Полное описание API CreatePlannedAccessPointForFloor.

Документация Cisco DNA Center по Devices DeletePlannedAccessPointForFloor

Полное описание API DeletePlannedAccessPointForFloor.

Документация Cisco DNA Center по Devices UpdatePlannedAccessPointForFloor

Полное описание API UpdatePlannedAccessPointForFloor.

Примеры

- name: Update all
  cisco.dnac.planned_access_points:
    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}}"
    state: present
    attributes:
      createDate: 0
      domain: string
      heirarchyName: string
      id: 0
      instanceUuid: string
      macaddress: string
      name: string
      source: string
      typeString: string
    floorId: string
    isSensor: true
    location:
      altitude: 0
      lattitude: 0
      longtitude: 0
    position:
      x: 0
      y: 0
      z: 0
    radioCount: 0
    radios:
    - antenna:
        azimuthAngle: 0
        elevationAngle: 0
        gain: 0
        mode: string
        name: string
        type: string
      attributes:
        channel: 0
        channelString: string
        id: 0
        ifMode: string
        ifTypeString: string
        ifTypeSubband: string
        instanceUuid: string
        slotId: 0
      isSensor: true

- name: Create
  cisco.dnac.planned_access_points:
    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}}"
    state: present
    attributes:
      createDate: 0
      domain: string
      heirarchyName: string
      id: 0
      instanceUuid: string
      macaddress: string
      name: string
      source: string
      typeString: string
    floorId: string
    isSensor: true
    location:
      altitude: 0
      lattitude: 0
      longtitude: 0
    position:
      x: 0
      y: 0
      z: 0
    radioCount: 0
    radios:
    - antenna:
        azimuthAngle: 0
        elevationAngle: 0
        gain: 0
        mode: string
        name: string
        type: string
      attributes:
        channel: 0
        channelString: string
        id: 0
        ifMode: string
        ifTypeString: string
        ifTypeSubband: string
        instanceUuid: string
        slotId: 0
      isSensor: true

- name: Delete by id
  cisco.dnac.planned_access_points:
    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}}"
    state: absent
    floorId: string
    plannedAccessPointUuid: string

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

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

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "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/planned_access_points_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API