Модуль cisco.dnac.network_settings_intent — Модуль ресурсов для пулов IP-адресов и сетевых функций
Примечание
Этот модуль входит в коллекцию cisco.dnac (версия 6.20.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в плейбуке, укажите: cisco.dnac.network_settings_intent.
В cisco.dnac 6.6.0
Описание
- Управление операциями над глобальным пулом, резервным пулом и сетевыми ресурсами.
- API для создания/обновления/удаления глобального пула.
- API для резервирования/обновления/удаления подпула IP-адресов из глобального пула.
- API для обновления сетевых настроек DHCP, Syslog, SNMP, NTP, сетевого AAA, AAA для клиентов и конечных устройств, а также настроек сервера DNS-центра.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- dnacentersdk == 2.4.5
- 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-пулу. |
|
pool_type string |
Включает как общий IP-пул, так и туннельный IP-пул. Общий - используется для общих целей в сети, таких как управление устройствами или связь между сетевыми устройствами. Туннельный - предназначен для туннельных интерфейсов для инкапсуляции пакетов в сетевой протокол. Он используется в VPN-подключениях, туннелях GRE или других типах наложенных сетей. Варианты:
|
|
prev_name string |
Прежний идентификатор глобального пула. Он должен использоваться только тогда, когда необходимо обновить имя глобального пула. |
|
network_management_details dictionary |
Установите настройки сети по умолчанию для сайта |
|
settings dictionary |
Настройки параметров управления сетью. |
|
client_and_endpoint_aaa dictionary |
Network V2’s clientAndEndpoint_aaa. |
|
ip_address string |
IP-адрес для ISE-сервера (например, 1.1.1.4). |
|
network string |
IP-адрес для AAA или ISE-сервера (например, 2.2.2.1). |
|
protocol string |
Протокол для AAA или ISE-сервера (например, RADIUS). |
|
servers string |
Тип сервера AAA или ISE-сервер (например, AAA). |
|
string |
Секретный ключ для ISE-сервера. |
|
dhcp_server list / elements=string |
IP-адрес DHCP-сервера (например, 1.1.1.1). |
|
dns_server dictionary |
Network V2’s dnsServer. |
|
domain_name string |
Доменное имя DHCP (например, cisco). |
|
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 |
Сообщение messageOfTheday из Network V2. |
|
banner_message string |
Сообщение для баннера (например, «Добрый день»). |
|
retain_existing_banner string |
Сохранить существующее сообщение баннера (например, «true» или «false»). |
|
netflow_collector dictionary |
netflowcollector из Network V2. |
|
ip_address string |
IP-адрес для коллектора NetFlow (например, 3.3.3.1). |
|
port integer |
Порт для коллектора NetFlow (например, 443). |
|
network_aaa dictionary |
network_aaa из Network V2. |
|
ip_address string |
IP-адрес для сервера AAA и ISE (например, 1.1.1.1). |
|
network string |
IP-адрес для сервера AAA или ISE (например, 2.2.2.2). |
|
protocol string |
Протокол для сервера AAA или ISE (например, RADIUS). |
|
servers string |
Тип сервера для сети AAA (например, AAA). |
|
string |
Секретный ключ для сервера ISE. |
|
ntp_server list / elements=string |
IP-адрес для NTP-сервера (например, 1.1.1.2). |
|
snmp_server dictionary |
snmpServer из Network V2. |
|
configure_dnac_ip boolean |
Настройка IP-адреса Cisco Catalyst Center для SNMP-сервера (например, true). Варианты:
|
|
ip_addresses list / elements=string |
IP-адрес для SNMP-сервера (например, 4.4.4.1). |
|
syslog_server dictionary |
syslogServer из Network V2. |
|
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). |
|
site_name string |
Имя сайта, указанное в качестве параметра пути, используется для указания места, где будет зарезервирован IP-подпул. |
|
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 |
IP v4 Глобальный пул адресов с cidr, пример 175.175.0.0/16. |
|
ipv4_prefix boolean |
Включена длина префикса ip4 или включен ввод общего количества хостов ipv4 Choices:
|
|
ipv4_prefix_length integer |
Длина префикса ipv4 необходима, когда значение ipv4_prefix истинно. |
|
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 Глобальный пул адресов с cidr, это поле обязательно, когда значение ipv6_address_space истинно, пример 2001 db8 85a3 /64. |
|
ipv6_prefix boolean |
Если значение ipv6 prefix истинно, поле ввода длины префикса ip6 включено, если ложно, включен ввод общего количества хостов ipv6. Choices:
|
|
ipv6_prefix_length integer |
Длина префикса IPv6 необходима, когда значение ipv6_prefix истинно. |
|
ipv6_subnet string |
Адрес IPv6-подсети, пример 2001 db8 85a3 0 100. |
|
ipv6_total_host integer |
Общее количество хостов для IPv6 необходимо, если значение ‘ipv6_prefix’ установлено как false. |
|
name string |
Имя резервного IP-подпула. |
|
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 DNA Center SDK для включения отладки. Варианты:
|
dnac_host string / обязательно | Имя хоста Cisco DNA 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 DNA Center для аутентификации. |
dnac_port string | Порт Cisco DNA Center. По умолчанию: |
dnac_task_poll_interval integer | Указывает интервал в секундах между последующими вызовами API для получения деталей задачи. По умолчанию: |
dnac_username псевдонимы: user string | Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: |
состояние строка | Состояние Cisco Catalyst Center после завершения модуля. Варианты:
|
validate_response_schema булево | Флаг для Cisco DNA 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 DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
Примеры
- name: Create global pool, reserve an ip pool and network
cisco.dnac.network_settings_intent:
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
gateway: string
ip_address_space: string
cidr: string
pool_type: Generic
dhcp_server_ips: list
dns_server_ips: list
reserve_pool_details:
ipv6_address_space: True
ipv4_global_pool: string
ipv4_prefix: True
ipv4_prefix_length: 9
ipv4_subnet: string
name: string
ipv6_prefix: True
ipv6_prefix_length: 64
ipv6_global_pool: string
ipv6_subnet: string
site_name: string
slaac_support: True
pool_type: LAN
network_management_details:
settings:
dhcp_server: list
dns_server:
domain_name: string
primary_ip_address: string
secondary_ip_address: string
client_and_endpoint_aaa:
network: string
protocol: string
servers: string
message_of_the_day:
banner_message: string
retain_existing_banner: string
netflow_collector:
ip_address: string
port: 443
network_aaa:
network: string
protocol: string
servers: string
ntp_server: list
snmp_server:
configure_dnac_ip: True
ip_addresses: list
syslog_server:
configure_dnac_ip: True
ip_addresses: list
site_name: string
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
response_1 словарь | Словарь или список с ответом, возвращенным Cisco DNA Center Python SDK Возвращается: всегда Пример: |
response_2 словарь | Словарь или список с ответом, возвращенным Cisco DNA Center Python SDK Возвращается: всегда Пример: |
response_3 словарь | Словарь или список с ответом, возвращенным Cisco DNA 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_intent_module.html