Spec-Zone.ru › Ansible

Модуль cisco.ise.network_device — Модуль ресурсов для сетевого устройства

Примечание

Этот модуль входит в состав коллекции cisco.ise (версия 2.9.3).

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

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

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

Новая версия в cisco.ise 1.0.0

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

Описание

  • Управление операциями создания, обновления и удаления ресурса «Сетевое устройство».
  • Этот API создаёт сетевое устройство.
  • Этот API удаляет сетевое устройство по ID.
  • Этот API удаляет сетевое устройство по имени.
  • Этот API позволяет клиенту обновить сетевое устройство по ID.
  • Этот API позволяет клиенту обновить сетевое устройство по имени.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

authenticationSettings

словарь

Параметры аутентификации сетевого устройства.

dtlsRequired

логическое

Это значение навязывает использование DTLS.

Варианты:

  • false
  • true

enabled

логическое

Флаг включения.

Варианты:

  • false
  • true

enableKeyWrap

логическое

Флаг включения KeyWrap.

Варианты:

  • false
  • true

enableMultiSecret

строка

Параметр enableMultiSecret сетевого устройства.

keyEncryptionKey

строка

Ключ шифрования ключа сетевого устройства.

keyInputFormat

строка

Допустимые значения — ASCII, - ШЕСТНАДЦАТИРИЧНЫЙ.

messageAuthenticatorCodeKey

строка

Ключ кода аутентификатора сообщения сетевого устройства.

networkProtocol

строка

Допустимые значения — RADIUS, - TACACS_PLUS.

radiusSharedSecret

строка

Секретный ключ RADIUS сетевого устройства.

secondRADIUSSharedSecret

строка

Второй секретный ключ RADIUS сетевого устройства.

coaPort

целое число

Порт COA сетевого устройства.

description

строка

Описание сетевого устройства.

dtlsDnsName

строка

Это значение используется для проверки идентификации клиента, содержащейся в сертификате клиента RADIUS/DTLS X.509.

id

строка

Идентификатор сетевого устройства.

ise_debug

логическое

Флаг для включения отладки в Identity Services Engine SDK.

Варианты:

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

ise_hostname

строка / обязательно

Имя хоста Identity Services Engine.

ise_password

строка / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

целое число

добавлен в cisco.ise 3.0.0

Таймаут (в секундах) для запросов RESTful HTTP.

По умолчанию: 60

ise_username

строка / обязательно

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

логическое

добавлен в cisco.ise 1.1.0

Флаг, указывающий SDK, использовать ли шлюз API Identity Services Engine для отправки запросов.

Если true, используется шлюз API ISE, и запросы отправляются по адресу https://{{ise_hostname}}.

Если false, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid).

Варианты:

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

ise_uses_csrf_token

логическое

добавлен в cisco.ise 3.0.0

Флаг, указывающий SDK, отправлять ли токен CSRF в API ERS ISE.

Если True, SDK предполагает, что проверка CSRF ISE включена.

Если True, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

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

ise_verify

boolean

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

Варианты:

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

ise_version

string

Уведомляет SDK, какую версию Identity Services Engine использовать.

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

ise_wait_on_rate_limit

boolean

Флаг для Identity Services Engine SDK, чтобы включить автоматическую обработку лимита запросов.

Варианты:

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

modelName

string

Модель сетевого устройства.

name

string

Имя сетевого устройства.

NetworkDeviceGroupList

list / elements=string

Список имён групп сетевых устройств для данного узла.

NetworkDeviceIPList

list / elements=dictionary

Список IP-подсетей для данного узла.

getIpaddressExclude

string

Может быть либо отдельным IP-адресом, либо диапазоном IP-адресов.

ipaddress

string

IP-адрес сетевого устройства.

mask

integer

Маска сетевого устройства. Может быть строкой, но будет преобразована в целое число.

profileName

string

Имя профиля сетевого устройства.

snmpsettings

dictionary

Настройки SNMP сетевого устройства.

linkTrapQuery

boolean

Флаг LinkTrapQuery.

Варианты:

  • false
  • true

macTrapQuery

boolean

Флаг MacTrapQuery.

Варианты:

  • false
  • true

originatingPolicyServicesNode

string

Узел originatingPolicyServicesNode сетевого устройства.

pollingInterval

integer

Интервал опроса сетевого устройства.

roCommunity

string

roCommunity сетевого устройства.

version

string

Версия сетевого устройства.

softwareVersion

string

Версия программного обеспечения сетевого устройства.

tacacsSettings

dictionary

Настройки TACACS сетевого устройства.

connectModeOptions

string

Допустимые значения — OFF, ON_LEGACY, ON_DRAFT_COMPLIANT.

sharedSecret

string

Секретный ключ общего доступа сетевого устройства.

trustsecsettings

dictionary

Настройки trustsec сетевого устройства.

deviceAuthenticationSettings

dictionary

Настройки аутентификации устройства.

sgaDeviceId

string

Идентификатор устройства sga.

sgaDevicePassword

string

Пароль sgaDevicePassword сетевого устройства.

deviceConfigurationDeployment

dictionary

deviceConfigurationDeployment сетевого устройства.

enableModePassword

string

Пароль enableModePassword сетевого устройства.

execModePassword

string

Пароль execModePassword сетевого устройства.

execModeUsername

string

Имя пользователя execModeUsername сетевого устройства.

includeWhenDeployingSGTUpdates

boolean

Флаг IncludeWhenDeployingSGTUpdates.

Варианты:

  • false
  • true

pushIdSupport

boolean

Флаг PushIdSupport.

Варианты:

  • false
  • true

sgaNotificationAndUpdates

dictionary

sgaNotificationAndUpdates сетевого устройства.

coaSourceHost

string

coaSourceHost сетевого устройства.

downlaodEnvironmentDataEveryXSeconds

integer

downlaodEnvironmentDataEveryXSeconds сетевого устройства.

downlaodPeerAuthorizationPolicyEveryXSeconds

integer

downlaodPeerAuthorizationPolicyEveryXSeconds сетевого устройства.

downloadSGACLListsEveryXSeconds

integer

downloadSGACLListsEveryXSeconds сетевого устройства.

otherSGADevicesToTrustThisDevice

boolean

Флаг OtherSGADevicesToTrustThisDevice.

Варианты:

  • false
  • true

reAuthenticationEveryXSeconds

integer

reAuthenticationEveryXSeconds сетевого устройства.

sendConfigurationToDevice

boolean

Флаг SendConfigurationToDevice.

Варианты:

  • false
  • true

sendConfigurationToDeviceUsing

string

Допустимые значения - ENABLE_USING_COA, - ENABLE_USING_CLI, - DISABLE_ALL.

Примечания

Примечание

  • Используемые методы SDK: network_device.NetworkDevice.create_network_device, network_device.NetworkDevice.delete_network_device_by_id, network_device.NetworkDevice.delete_network_device_by_name, network_device.NetworkDevice.update_network_device_by_id, network_device.NetworkDevice.update_network_device_by_name,
  • Используемые пути: post /ers/config/networkdevice, delete /ers/config/networkdevice/name/{name}, delete /ers/config/networkdevice/{id}, put /ers/config/networkdevice/name/{name}, put /ers/config/networkdevice/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by name
  cisco.ise.network_device:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    NetworkDeviceGroupList:
    - string
    NetworkDeviceIPList:
    - getIpaddressExclude: string
      ipaddress: string
      mask: 0
    authenticationSettings:
      dtlsRequired: true
      enableKeyWrap: true
      enableMultiSecret: string
      enabled: true
      keyEncryptionKey: string
      keyInputFormat: string
      messageAuthenticatorCodeKey: string
      networkProtocol: string
      radiusSharedSecret: string
      secondRadiusSharedSecret: string
    coaPort: 0
    description: string
    dtlsDnsName: string
    id: string
    modelName: string
    name: string
    profileName: string
    snmpsettings:
      linkTrapQuery: true
      macTrapQuery: true
      originatingPolicyServicesNode: string
      pollingInterval: 0
      roCommunity: string
      version: string
    softwareVersion: string
    tacacsSettings:
      connectModeOptions: string
      sharedSecret: string
    trustsecsettings:
      deviceAuthenticationSettings:
        sgaDeviceId: string
        sgaDevicePassword: string
      deviceConfigurationDeployment:
        enableModePassword: string
        execModePassword: string
        execModeUsername: string
        includeWhenDeployingSGTUpdates: true
      pushIdSupport: true
      sgaNotificationAndUpdates:
        coaSourceHost: string
        downlaodEnvironmentDataEveryXSeconds: 0
        downlaodPeerAuthorizationPolicyEveryXSeconds: 0
        downloadSGACLListsEveryXSeconds: 0
        otherSGADevicesToTrustThisDevice: true
        reAuthenticationEveryXSeconds: 0
        sendConfigurationToDevice: true
        sendConfigurationToDeviceUsing: string

- name: Delete by name
  cisco.ise.network_device:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    name: string

- name: Update by id
  cisco.ise.network_device:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    NetworkDeviceGroupList:
    - string
    NetworkDeviceIPList:
    - getIpaddressExclude: string
      ipaddress: string
      mask: 0
    authenticationSettings:
      dtlsRequired: true
      enableKeyWrap: true
      enableMultiSecret: string
      enabled: true
      keyEncryptionKey: string
      keyInputFormat: string
      messageAuthenticatorCodeKey: string
      networkProtocol: string
      radiusSharedSecret: string
      secondRadiusSharedSecret: string
    coaPort: 0
    description: string
    dtlsDnsName: string
    id: string
    modelName: string
    name: string
    profileName: string
    snmpsettings:
      linkTrapQuery: true
      macTrapQuery: true
      originatingPolicyServicesNode: string
      pollingInterval: 0
      roCommunity: string
      version: string
    softwareVersion: string
    tacacsSettings:
      connectModeOptions: string
      sharedSecret: string
    trustsecsettings:
      deviceAuthenticationSettings:
        sgaDeviceId: string
        sgaDevicePassword: string
      deviceConfigurationDeployment:
        enableModePassword: string
        execModePassword: string
        execModeUsername: string
        includeWhenDeployingSGTUpdates: true
      pushIdSupport: true
      sgaNotificationAndUpdates:
        coaSourceHost: string
        downlaodEnvironmentDataEveryXSeconds: 0
        downlaodPeerAuthorizationPolicyEveryXSeconds: 0
        downloadSGACLListsEveryXSeconds: 0
        otherSGADevicesToTrustThisDevice: true
        reAuthenticationEveryXSeconds: 0
        sendConfigurationToDevice: true
        sendConfigurationToDeviceUsing: string

- name: Delete by id
  cisco.ise.network_device:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

- name: Create
  cisco.ise.network_device:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    NetworkDeviceGroupList:
    - string
    NetworkDeviceIPList:
    - getIpaddressExclude: string
      ipaddress: string
      mask: 0
    authenticationSettings:
      dtlsRequired: true
      enableKeyWrap: true
      enableMultiSecret: string
      enabled: true
      keyEncryptionKey: string
      keyInputFormat: string
      messageAuthenticatorCodeKey: string
      networkProtocol: string
      radiusSharedSecret: string
      secondRadiusSharedSecret: string
    coaPort: 0
    description: string
    dtlsDnsName: string
    modelName: string
    name: string
    profileName: string
    snmpsettings:
      linkTrapQuery: true
      macTrapQuery: true
      originatingPolicyServicesNode: string
      pollingInterval: 0
      roCommunity: string
      version: string
    softwareVersion: string
    tacacsSettings:
      connectModeOptions: string
      sharedSecret: string
    trustsecsettings:
      deviceAuthenticationSettings:
        sgaDeviceId: string
        sgaDevicePassword: string
      deviceConfigurationDeployment:
        enableModePassword: string
        execModePassword: string
        execModeUsername: string
        includeWhenDeployingSGTUpdates: true
      pushIdSupport: true
      sgaNotificationAndUpdates:
        coaSourceHost: string
        downlaodEnvironmentDataEveryXSeconds: 0
        downlaodPeerAuthorizationPolicyEveryXSeconds: 0
        downloadSGACLListsEveryXSeconds: 0
        otherSGADevicesToTrustThisDevice: true
        reAuthenticationEveryXSeconds: 0
        sendConfigurationToDevice: true
        sendConfigurationToDeviceUsing: string

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

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

Ключ

Описание

ise_response

словарь

Словарь или список со значением возврата Python SDK Cisco ISE

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

Пример: {"NetworkDeviceGroupList": ["string"], "NetworkDeviceIPList": [{"getIpaddressExclude": "string", "ipaddress": "string", "mask": 0}], "authenticationSettings": {"dtlsRequired": true, "enableKeyWrap": true, "enableMultiSecret": "string", "enabled": true, "keyEncryptionKey": "string", "keyInputFormat": "string", "messageAuthenticatorCodeKey": "string", "networkProtocol": "string", "radiusSharedSecret": "string", "secondRadiusSharedSecret": "string"}, "coaPort": 0, "description": "string", "dtlsDnsName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "modelName": "string", "name": "string", "profileName": "string", "snmpsettings": {"linkTrapQuery": true, "macTrapQuery": true, "originatingPolicyServicesNode": "string", "pollingInterval": 0, "roCommunity": "string", "version": "string"}, "softwareVersion": "string", "tacacsSettings": {"connectModeOptions": "string", "sharedSecret": "string"}, "trustsecsettings": {"deviceAuthenticationSettings": {"sgaDeviceId": "string", "sgaDevicePassword": "string"}, "deviceConfigurationDeployment": {"enableModePassword": "string", "execModePassword": "string", "execModeUsername": "string", "includeWhenDeployingSGTUpdates": true}, "pushIdSupport": true, "sgaNotificationAndUpdates": {"coaSourceHost": "string", "downlaodEnvironmentDataEveryXSeconds": 0, "downlaodPeerAuthorizationPolicyEveryXSeconds": 0, "downloadSGACLListsEveryXSeconds": 0, "otherSGADevicesToTrustThisDevice": true, "reAuthenticationEveryXSeconds": 0, "sendConfigurationToDevice": true, "sendConfigurationToDeviceUsing": "string"}}}

ise_update_response

словарь

добавлен в cisco.ise 1.1.0

Словарь или список со значением возврата Python SDK Cisco ISE

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

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/ise/network_device_module.html

Spec-Zone.ru

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