cisco.dnac.network_settings_workflow_manager модуль — Модуль ресурсов для пулов IP-адресов и сетевых функций
Примечание
Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробной информации.
Для использования в плейбуке укажите: cisco.dnac.network_settings_workflow_manager.
Добавлена в cisco.dnac 6.6.0
Описание
- Управление операциями над глобальным пулом, резервным пулом, сетевыми ресурсами.
- API для создания/обновления/удаления глобального пула.
- API для резервирования/обновления/удаления подпула IP из глобального пула.
- API для обновления сетевых настроек DHCP, Syslog, SNMP, NTP, сетевого AAA, AAA для клиентов и конечных устройств и/или настроек сервера центра DNS.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- dnacentersdk >= 2.7.2
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
config list / elements=dictionary / required | Список подробных сведений о глобальном пуле, зарезервированном пуле и управляемой сети. |
|
global_pool_details dictionary |
Управляет IPv4 и IPv6 IP-пулами на глобальном уровне. |
|
settings dictionary |
Параметры глобального пула. |
|
ip_pool list / elements=dictionary |
Содержит список конфигураций глобального IP-пула. |
|
cidr string |
Определяет блок междоменной маршрутизации без классов IP-пула, обеспечивая систематическое распределение IP-адресов в сети. |
|
dhcp_server_ips list / elements=string |
IP-адреса DHCP-серверов, отвечающие за автоматическое назначение IP-адресов и параметров конфигурации сети устройствам в локальной сети. |
|
dns_server_ips list / elements=string |
Ответственны за преобразование доменных имен в соответствующие IP-адреса. |
|
gateway string |
Служит точкой входа или выхода для трафика данных между сетями. |
|
ip_address_space string |
IP-адресное пространство IPv4 или IPv6. |
|
name string |
Указывает имя, присвоенное глобальному IP-пулу. Обязательно для операций в глобальном IP-пуле. Длина должна быть меньше или равна 100. Допускаются только буквы, цифры и символы -_./. |
|
pool_type string |
Включает в себя как общий IP-пул, так и туннельный IP-пул. Общий - используется для общих целей в сети, таких как управление устройствами или связь между сетевыми устройствами. Туннельный - предназначен для туннельных интерфейсов для инкапсуляции пакетов в сетевой протокол. Он используется в VPN-подключениях, GRE-туннелях или других типах наложенных сетей. Варианты:
|
|
prev_name string |
Прежний идентификатор глобального пула. Он должен использоваться исключительно, когда необходимо обновить имя глобального пула. |
|
network_management_details list / elements=dictionary |
Установите параметры сети по умолчанию для сайта |
|
settings dictionary |
Параметры сведений об управлении сетью. |
|
client_and_endpoint_aaa dictionary |
Управляет AAA (аутентификация, авторизация, учет) для клиентов и конечных точек. |
|
pan_address string добавлено в cisco.dnac 6.14.0 |
IP-адрес PAN для сервера ISE. Например, 1.1.1.1. |
|
primary_server_address string добавлено в cisco.dnac 6.14.0 |
Основной IP-адрес для сервера ISE/AAA. Например, 1.1.1.2. |
|
protocol string |
Протокол для сервера AAA или ISE. Варианты:
|
|
secondary_server_address string добавлено в cisco.dnac 6.14.0 |
Вторичный IP-адрес для сервера AAA. Например, 1.1.1.3. |
|
server_type string |
Тип сервера для управления AAA для клиентов и конечных точек. Варианты:
|
|
string |
Секретный ключ для ISE-сервера. Длина секретного ключа должна быть не менее 4 символов. |
|
dhcp_server list / elements=string |
IP-адрес DHCP-сервера (например, 1.1.1.4). |
|
dns_server dictionary |
Данные DNS-сервера сети в пределах определенного сайта. |
|
domain_name string |
Доменное имя DHCP (например, cisco.com, cisco.net). |
|
primary_ip_address string |
Основной IP-адрес для DHCP (например, 2.2.2.2). |
|
secondary_ip_address string |
Вторичный IP-адрес для DHCP (например, 3.3.3.3). |
|
message_of_the_day dictionary |
Данные баннера на определенном сайте. |
|
banner_message string |
Сообщение для баннера (например, Добрый день). |
|
retain_existing_banner boolean |
Сохранить существующее сообщение баннера. Варианты:
|
|
netflow_collector dictionary |
Конфигурация коллектора NetFlow для определенного сайта. |
|
collector_type string |
Тип коллектора NetFlow. Поддерживаемые значения включают «Builtin» и «Telemetry_broker_or_UDP_director». Применимо начиная с версии Cisco Catalyst Center 2.3.7.6 и выше. Варианты:
|
|
enable_on_wired_access_devices boolean |
Включить или отключить устройство проводного доступа. Применимо начиная с версии Cisco Catalyst Center 2.3.7.6 и выше. Варианты:
|
|
ip_address string |
IP-адрес для коллектора NetFlow. Например, 3.3.3.1. |
|
port integer |
Номер порта, используемый коллектором NetFlow. Например, 443. |
|
network_aaa dictionary |
Управляет AAA (Authentication Authorization Accounting) для сетевых устройств. |
|
pan_address string added in cisco.dnac 6.14.0 |
IP-адрес PAN для ISE-сервера. Например, 1.1.1.1. |
|
primary_server_address string added in cisco.dnac 6.14.0 |
Основной IP-адрес для ISE/AAA-сервера. Например, 1.1.1.2. |
|
protocol string |
Протокол для AAA или ISE-сервера. Варианты:
|
|
secondary_server_address string added in cisco.dnac 6.14.0 |
Вторичный IP-адрес для AAA-сервера. Например, 1.1.1.3. |
|
server_type string |
Тип сервера для управления AAA для сетевых устройств. Варианты:
|
|
string |
Секретный ключ для сервера ISE. Длина секретного ключа должна быть не менее 4 символов. |
|
ntp_server list / elements=string |
IP-адрес сервера NTP в конкретном сайте (например, 1.1.1.2). |
|
snmp_server dictionary |
Детали сервера SNMP в конкретном сайте. |
|
configure_dnac_ip boolean |
Настройка IP-адреса Cisco Catalyst Center для сервера SNMP (например, true). Варианты:
|
|
ip_addresses list / elements=string |
IP-адрес сервера SNMP (например, 4.4.4.1). |
|
syslog_server dictionary |
Детали сервера syslog в конкретном сайте. |
|
configure_dnac_ip boolean |
Настройка IP-адреса Cisco Catalyst Center для сервера syslog (например, true). Варианты:
|
|
ip_addresses list / elements=string |
IP-адрес сервера syslog (например, 4.4.4.4). |
|
timezone string |
Часовой пояс конкретного сайта (например, Africa/Abidjan/GMT). |
|
wired_data_collection dictionary |
Включает или выключает сбор данных с проводных сетевых устройств для целей телеметрии и мониторинга. Применимо для версий Cisco Catalyst Center 2.3.7.6 и выше. |
|
enable_wired_data_collection boolean |
Включить или отключить сбор данных с проводных устройств. Варианты:
|
|
wireless_telemetry dictionary |
Включает или выключает сбор данных телеметрии с беспроводных сетевых устройств для мониторинга производительности и анализа. Применимо для версий Cisco Catalyst Center 2.3.7.6 и выше. |
|
enable_wireless_telemetry boolean |
Включить или отключить беспроводную телеметрию. Варианты:
|
|
site_name string |
Имя сайта, указанное в параметре пути, используемое для указания места резервирования подсети IP (например, Global/Chennai/Trill). |
|
reserve_pool_details dictionary |
Детали резервируемой подсети IP из глобального пула. |
|
ipv4_dhcp_servers list / elements=string |
Указывает IPv4-адреса серверов DHCP, например, «1.1.1.1». |
|
ipv4_dns_servers list / elements=string |
Указывает IPv4-адреса DNS-серверов, например, «4.4.4.4». |
|
ipv4_gateway string added in cisco.dnac 4.0.0 |
Предоставляет IPv4-адрес шлюза, например, «175.175.0.1». |
|
ipv4_global_pool string |
IPv4 адрес глобального пула с CIDR, например 175.175.0.0/16. Если указаны как ‘ipv6_global_pool’, так и ‘ipv4_global_pool_name’, приоритет отдается ‘ipv4_global_pool’. |
|
ipv4_global_pool_name string added in cisco.dnac 6.14.0 |
Указывает имя, которое будет ассоциировано с IPv4 глобальным пулом. Если указаны как ‘ipv4_global_pool’, так и ‘ipv4_global_pool_name’, приоритет отдается ‘ipv4_global_pool’. |
|
ipv4_prefix boolean |
Включена ли длина префикса ip4 или включен ввод общего количества узлов ipv4 Choices:
|
|
ipv4_prefix_length integer |
Длина префикса ipv4 необходима, когда значение ipv4_prefix равно true. |
|
ipv4_subnet string |
Указывает адрес IPv4-подсети, например, «175.175.0.0». |
|
ipv4_total_host integer |
Общее количество узлов для IPv4, необходимо, когда ‘ipv4_prefix’ установлено в false. |
|
ipv6_address_space boolean |
Определяет, необходимы ли ввод как IPv6, так и IPv4. Если установлено значение false, необходим только ввод IPv4. Если установлено значение true, необходимы как IPv6, так и IPv4 вводы. Choices:
|
|
ipv6_dhcp_servers list / elements=string |
Указывает IPv6-адреса для DHCP-серверов в формате. Например, «2001:0db8:0123:4567:89ab:cdef:0001:0001». |
|
ipv6_dns_servers list / elements=string |
Указывает IPv6-адреса для DNS-серверов. Например, «2001:0db8:0123:4567:89ab:cdef:0002:0002». |
|
ipv6_gateway string |
Предоставляет IPv6-адрес шлюза. Например, «2001:0db8:0123:4567:89ab:cdef:0003:0003». |
|
ipv6_global_pool string |
ipv6_global_pool является обязательным, когда ipv6_address_space установлено в true. Указывает глобальный пул IPv6-адресов, используя нотацию CIDR, например, «2001:db8:85a3::/64». В случаях, когда указаны как ipv6_global_pool, так и ipv6_global_pool_name, приоритет будет отдаваться ipv6_global_pool. |
|
ipv6_global_pool_name string added in cisco.dnac 6.14.0 |
Указывает имя, присвоенное глобальному пулу IP v6. Если указаны как ‘ipv6_global_pool’, так и ‘ipv6_global_pool_name’, приоритет будет отдан ‘ipv6_global_pool’. |
|
ipv6_prefix boolean |
Определяет, следует ли включать поле ввода «ipv6_prefix_length» или «ipv6_total_host». Если значение префикса IPv6 равно true, необходимо поле ввода длины префикса IPv6. Если оно равно false, необходим ввод общего количества узлов ipv6. Choices:
|
|
ipv6_prefix_length integer |
Указывает длину префикса IPv6. Необходимо, когда «ipv6_prefix» установлено в true. |
|
ipv6_subnet string |
Адрес IPv6-подсети, пример 2001:db8:85a3:0:100. |
|
ipv6_total_host integer |
Указывает общее количество узлов IPv6. Необходимо, когда «ipv6_prefix» установлено в false. Необходимо указать количество IPv6-адресов, меньшее 256. |
|
name string |
Имя резервного IP-подпула. Обязательно для операций в резервном пуле IP. Длина должна быть меньше или равна 100. Допускаются только буквы, цифры и символы -_./. |
|
pool_type string |
Тип резервного IP-подпула. Generic - используется для общих целей в сети, таких как управление устройствами или связь между сетевыми устройствами. LAN - используется для устройств и ресурсов в локальной сети, таких как подключение устройств, внутренняя связь или службы. Management - используется для целей управления, таких как интерфейсы управления устройствами, доступ к управлению или другие административные функции. Service - используется для сетевых служб и приложений, таких как DNS (система доменных имен), DHCP (протокол динамической конфигурации узла), NTP (протокол сетевого времени). WAN - используется для устройств и ресурсов в глобальной сети, таких как межсоединение удаленных сайтов с другими сетями или службами, размещенными в глобальной сети. Choices:
|
|
prev_name string |
Прежнее имя, связанное с резервным IP-подпулом. |
|
site_name string |
Имя сайта, указанное в качестве параметра пути, используется для указания места, где будет зарезервирован IP-подпул. |
|
slaac_support boolean |
Позволяет устройствам в сетях IPv6 автономно настраивать свои IP-адреса, устраняя необходимость в ручной настройке. Варианты:
|
config_verify boolean | Установите значение True, чтобы проверить Cisco Catalyst Center после применения конфигурации playbook. Варианты:
|
dnac_api_task_timeout integer | Определяет время ожидания в секундах для вызовов API для получения подробных сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания. По умолчанию: |
dnac_debug boolean | Указывает, включена ли отладка в Cisco Catalyst Center SDK. Варианты:
|
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”. Варианты:
|
dnac_log_append boolean | Определяет режим файла. Установите значение True для режима ‘добавления’. Установите значение False для режима ‘записи’. Варианты:
|
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. По умолчанию: |
dnac_log_level string | Устанавливает порог для уровня журнала. Сообщения с уровнем, равным или выше этого, будут регистрироваться. Уровни перечислены в порядке серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL указывает на серьезные ошибки, которые приостанавливают работу программы. Отображаются только сообщения CRITICAL. ERROR указывает на проблемы, препятствующие выполнению функции. Отображаются сообщения ERROR и CRITICAL. WARNING указывает на потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL. INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL. DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала. По умолчанию: |
dnac_password string | Пароль для аутентификации в Cisco Catalyst Center. |
dnac_port string | Указывает номер порта, связанного с Cisco Catalyst Center. По умолчанию: |
dnac_task_poll_interval integer | Указывает интервал в секундах между последовательными вызовами API для получения подробных сведений о задаче. По умолчанию: |
dnac_username aliases: user string | Имя пользователя для аутентификации в Cisco Catalyst Center. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Указывает версию Cisco Catalyst Center, которую должен использовать SDK. По умолчанию: |
состояние строка | Состояние Cisco Catalyst Center после завершения модуля. Варианты:
|
validate_response_schema булево | Флаг для Cisco Catalyst Center SDK для включения проверки заголовков запроса по JSON-схеме. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: network_settings.NetworkSettings.create_global_pool, network_settings.NetworkSettings.delete_global_ip_pool, network_settings.NetworkSettings.update_global_pool, network_settings.NetworkSettings.release_reserve_ip_subpool, network_settings.NetworkSettings.reserve_ip_subpool, network_settings.NetworkSettings.update_reserve_ip_subpool, network_settings.NetworkSettings.update_network_v2,
- Используемые пути: post /dna/intent/api/v1/global-pool, delete /dna/intent/api/v1/global-pool/{id}, put /dna/intent/api/v1/global-pool, post /dna/intent/api/v1/reserve-ip-subpool/{siteId}, delete /dna/intent/api/v1/reserve-ip-subpool/{id}, put /dna/intent/api/v1/reserve-ip-subpool/{siteId}, put /dna/intent/api/v2/network/{siteId},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, вместо этого использует встроенный менеджер подключений из Cisco Catalyst Center SDK
- Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления подключения
Примеры
- name: Create global pool
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- global_pool_details:
settings:
ip_pool:
- name: string
pool_type: Generic
ip_address_space: string
cidr: string
gateway: string
dhcp_server_ips: list
dns_server_ips: list
- name: Create reserve an ip pool
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- reserve_pool_details:
- site_name: string
name: string
pool_type: LAN
ipv6_address_space: True
ipv4_global_pool: string
ipv4_prefix: True
ipv4_prefix_length: 9
ipv4_subnet: string
ipv6_prefix: True
ipv6_prefix_length: 64
ipv6_global_pool: string
ipv6_subnet: string
slaac_support: True
- name: Create reserve an ip pool using global pool name
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- reserve_pool_details:
- name: string
site_name: string
pool_type: LAN
ipv6_address_space: True
ipv4_global_pool_name: string
ipv4_prefix: True
ipv4_prefix_length: 9
ipv4_subnet: string
ipv6_prefix: True
ipv6_prefix_length: 64
ipv6_global_pool_name: string
ipv6_subnet: string
slaac_support: True
- name: Delete reserved pool
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: deleted
config_verify: True
config:
- reserve_pool_details:
- site_name: string
name: string
- name: Manage the network functions
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- network_management_details:
- site_name: string
settings:
dhcp_server: list
dns_server:
domain_name: string
primary_ip_address: string
secondary_ip_address: string
ntp_server: list
timezone: string
message_of_the_day:
banner_message: string
retain_existing_banner: bool
netflow_collector:
ip_address: string
port: 443
snmp_server:
configure_dnac_ip: True
ip_addresses: list
syslog_server:
configure_dnac_ip: True
ip_addresses: list
- name: Adding the network_aaa and client_and_endpoint_aaa AAA server
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- network_management_details:
- site_name: string
settings:
network_aaa:
server_type: AAA
primary_server_address: string
secondary_server_address: string
protocol: string
client_and_endpoint_aaa:
server_type: AAA
primary_server_address: string
secondary_server_address: string
protocol: string
- name: Adding the network_aaa and client_and_endpoint_aaa ISE server
cisco.dnac.network_settings_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: True
dnac_log_level: "{{ dnac_log_level }}"
state: merged
config_verify: True
config:
- network_management_details:
- site_name: string
settings:
network_aaa:
server_type: ISE
pan_address: string
primary_server_address: string
protocol: string
client_and_endpoint_aaa:
server_type: ISE
pan_address: string
primary_server_address: string
protocol: string
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
response_1 словарь | Словарь или список с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращается: всегда Пример: |
response_2 словарь | Словарь или список с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращается: всегда Пример: |
response_3 словарь | Словарь или список с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращается: всегда Пример: |
Ссылки на сборку
© 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/network_settings_workflow_manager_module.html