Модуль cisco.mso.ndo_macsec_policy — управление политиками MACsec в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.mso.ndo_macsec_policy.

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Управление политиками MACsec в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND v3.1 (NDO v4.3) и более поздних версиях.

Требования

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

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
admin_state string	Административное состояние политики MACsec (включение или отключение политики). Значение по умолчанию — `enabled`. Варианты: `"enabled"` `"disabled"`
cipher_suite string	Набор алгоритмов шифрования, используемый для шифрования. Значение по умолчанию — `256_gcm_aes_xpn`. Варианты: `"128_gcm_aes"` `"128_gcm_aes_xpn"` `"256_gcm_aes"` `"256_gcm_aes_xpn"`
confidentiality_offset integer	Смещение конфиденциальности для политики MACsec. Значение по умолчанию — 0. Этот параметр доступен только для типа `access`. Варианты: `0` `30` `50`
description string	Описание политики MACsec.
host псевдонимы: hostname string	IP-адрес или имя хоста узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_HOST`.
interface_type string	Тип интерфейсов, к которым будет применена эта политика. Варианты: `"fabric"` ← (по умолчанию) `"access"`
key_server_priority integer	Приоритет сервера ключей для политики MACsec. Значение должно находиться в диапазоне от 0 до 255. Значение по умолчанию для типа `access` — 16. Этот параметр доступен только для типа `access`.
login_domain string	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_login_domain`.
macsec_keys list / элементы=dictionary	Список ключей MACsec. Пустой список удалит `macsec_keys` из политики MACsec. При обновлении существующие записи `macsec_keys` будут заменены новыми.
end_time string	Время окончания действия ключа MACsec. Формат даты и времени: YYYY-MM-DD HH:MM:SS или ‘infinite’ Значение по умолчанию — `infinite`.
key_name string / обязательный	Имя ключа MACsec. Имя ключа должно состоять из шестнадцатеричных символов [0-9a-fA-F]
psk string / обязательный	Предварительно установленный ключ (PSK) для ключа MACsec. Длина PSK должна составлять 64 символа, если набор алгоритмов шифрования — `256_gcm_aes` или `256_gcm_aes_xpn`. Длина PSK должна составлять 32 символа, если набор алгоритмов шифрования — `128_gcm_aes` или `128_gcm_aes_xpn`. PSK должен состоять из шестнадцатеричных символов [0-9a-fA-F]
start_time string	Время начала действия ключа MACsec. Формат даты и времени: YYYY-MM-DD HH:MM:SS или ‘now’ Время начала для каждого key_name должно быть уникальным. Значение по умолчанию — `now`.
macsec_policy псевдонимы: name string	Имя политики MACsec.
macsec_policy_uuid псевдонимы: uuid string	UUID политики MACsec. Этот параметр обязателен, если требуется обновить `macsec_policy`.
output_level string	Управляет выводом этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационные данные, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочные данные, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_PORT`.
sak_expiry_time integer	Время истечения срока действия ключа ассоциации безопасности (SAK) для политики MACsec. Значение должно быть равно 0 или находиться в диапазоне от 60 до 2592000. Значение по умолчанию — 0.
security_policy string	Политика безопасности, разрешающая передачу трафика по каналу для политики MACsec. Значение по умолчанию — `should_secure`. Варианты: `"should_secure"` `"must_secure"`
state string	Используйте `absent` для удаления. Используйте `query` для получения списка одного или нескольких объектов. Используйте `present` для создания или обновления. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template string / обязательный	Имя шаблона. Шаблон должен быть шаблоном политики фабрики.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_TIMEOUT`.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо подключения HTTPS по умолчанию будет использоваться подключение HTTP. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаря `ansible_httpapi_use_ssl`. По умолчанию используется `false` при работе с плагином подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs boolean	Если `false`, проверка SSL-сертификатов выполняться не будет. Значение `false` следует задавать только для самостоятельно контролируемых сайтов с самозаверяющими сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`
window_size integer	Размер окна определяет максимальное количество кадров, которые могут быть получены не по порядку до обнаружения атаки с повторным воспроизведением. Значение должно находиться в диапазоне от 0 до 4294967295. Значение по умолчанию равно 0 для типа `fabric` и 64 для типа `access`.

Примечания

Примечание

Этот модуль разработан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все его функции могут не работать в более ранних версиях.

Примеры

- name: Create a new MACsec Policy of interface_type fabric
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    macsec_policy: ansible_test_macsec_policy
    description: "Ansible Test MACsec Policy"
    state: present

- name: Create a new MACsec Policy of interface_type access
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    macsec_policy: ansible_test_macsec_policy
    description: "Ansible Test MACsec Policy"
    macsec_keys:
      - key_name: ansible_test_key
        psk: 'AA111111111111111111111111111111111111111111111111111111111111aa'
        start_time: '2029-12-11 11:12:13'
        end_time: 'infinite'
    state: present

- name: Query a MACsec Policy with macsec_policy name
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    macsec_policy: ansible_test_macsec_policy
    state: query
  register: query_one

- name: Query all MACsec Policies
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    state: query
  register: query_all

- name: Query a MACsec Policy with macsec_policy UUID
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    macsec_policy_uuid: ansible_test_macsec_policy_uuid
    state: query
  register: query_uuid

- name: Delete a MACsec Policy with name
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    macsec_policy: ansible_test_macsec_policy
    state: absent

- name: Delete a MACsec Policy with UUID
  cisco.mso.ndo_macsec_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test_template
    macsec_policy_uuid: ansible_test_macsec_policy_uuid
    state: absent

Авторы

Anvitha Jain (@anvjain)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/ndo_macsec_policy_module.html