Модуль cisco.meraki.organizations_login_security — модуль ресурсов для organizations _loginsecurity

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.organizations_login_security.

Добавлен в cisco.meraki 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

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

Управление операцией обновления ресурса organizations _loginsecurity.
Обновление параметров безопасности входа в систему для организации.

Примечание

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

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
accountLockoutAttempts integer	Количество последовательных неудачных попыток входа, после которого учетные записи пользователей будут заблокированы.
apiAuthentication dictionary	Сведения о том, будет ли организация ограничивать доступ к API (но не к Dashboard) с определенных IP-адресов.
ipRestrictionsForKeys dictionary	Сведения об ограничениях IP-адресов только для API.
enabled boolean	Логическое значение, указывающее, будет ли организация ограничивать использование ключей API (но не графического интерфейса Dashboard) определенным списком IP-адресов или диапазонов CIDR. Варианты: `false` `true`
ranges list / elements=string	Список допустимых диапазонов IP-адресов. Записи могут содержать отдельные IP-адреса, диапазоны IP-адресов и подсети CIDR.
enforceAccountLockout boolean	Логическое значение, указывающее, будут ли учетные записи пользователей Dashboard блокироваться после указанного количества последовательных неудачных попыток входа. Варианты: `false` `true`
enforceDifferentPasswords boolean	Логическое значение, указывающее, должны ли пользователи при установке нового пароля выбирать пароль, отличный от всех предыдущих. Варианты: `false` `true`
enforceIdleTimeout boolean	Логическое значение, указывающее, будут ли пользователи выходить из системы после периода бездействия, равного указанному количеству минут. Варианты: `false` `true`
enforceLoginIpRanges boolean	Логическое значение, указывающее, будет ли организация ограничивать доступ к Dashboard (включая API) с определенных IP-адресов. Варианты: `false` `true`
enforcePasswordExpiration boolean	Логическое значение, указывающее, должны ли пользователи менять пароль каждые X дней. Варианты: `false` `true`
enforceStrongPasswords boolean	Устарело. Значения «false» всегда игнорируются. Варианты: `false` `true`
enforceTwoFactorAuth boolean	Логическое значение, указывающее, должны ли пользователи этой организации при входе в Dashboard вводить дополнительный код подтверждения. Код будет отправлен на их мобильный телефон по SMS или сгенерирован приложением-аутентификатором. Варианты: `false` `true`
idleTimeoutMinutes integer	Количество минут бездействия, после которого пользователи будут выходить из своих учетных записей.
loginIpRanges list / elements=string	Список допустимых диапазонов IP-адресов. Записи могут содержать отдельные IP-адреса, диапазоны IP-адресов и подсети CIDR.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный в панели управления; также его можно задать с помощью переменной окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также его можно задать с помощью переменной окружения BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временной меткой По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для вывода журнала; если он не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное количество повторных попыток при получении ошибок 429 или других ошибок сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт для HTTPS, если они требуются По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять запрос при получении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором при другой ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все журналы? Тогда вы действуете на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять запрос при получении ошибки ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
minimumPasswordLength integer	Минимальное количество символов в паролях администраторов.
numDifferentPasswords integer	Количество последних паролей, от которых должен отличаться новый пароль.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
passwordExpirationDays integer	Количество дней, по истечении которых пользователи должны будут сменить пароль.

Примечания

Примечание

Используемый метод SDK: organizations.Organizations.update_organization_login_security,
Используемый путь: put /organizations/{organizationId}/loginSecurity,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует подключаемые модули соединения Ansible, а вместо этого использует встроенный менеджер соединений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco Meraki по методу organizations updateOrganizationLoginSecurity: Полное описание API updateOrganizationLoginSecurity.

Примеры

- name: Update all
  cisco.meraki.organizations_login_security:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    accountLockoutAttempts: 3
    apiAuthentication:
      ipRestrictionsForKeys:
        enabled: true
        ranges:
          - 192.195.83.1
          - 192.168.33.33
    enforceAccountLockout: true
    enforceDifferentPasswords: true
    enforceIdleTimeout: true
    enforceLoginIpRanges: true
    enforcePasswordExpiration: true
    enforceStrongPasswords: true
    enforceTwoFactorAuth: true
    idleTimeoutMinutes: 30
    loginIpRanges:
      - 192.195.83.1
      - 192.195.83.255
    minimumPasswordLength: 12
    numDifferentPasswords: 3
    organizationId: string
    passwordExpirationDays: 90

Возвращаемые значения

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"accountLockoutAttempts": 0, "apiAuthentication": {"ipRestrictionsForKeys": {"enabled": true, "ranges": ["string"]}}, "enforceAccountLockout": true, "enforceDifferentPasswords": true, "enforceIdleTimeout": true, "enforceLoginIpRanges": true, "enforcePasswordExpiration": true, "enforceStrongPasswords": true, "enforceTwoFactorAuth": true, "idleTimeoutMinutes": 0, "loginIpRanges": ["string"], "minimumPasswordLength": 0, "numDifferentPasswords": 0, "passwordExpirationDays": 0}`

Ключ

Описание

dictionary

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

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

Пример: {"accountLockoutAttempts": 0, "apiAuthentication": {"ipRestrictionsForKeys": {"enabled": true, "ranges": ["string"]}}, "enforceAccountLockout": true, "enforceDifferentPasswords": true, "enforceIdleTimeout": true, "enforceLoginIpRanges": true, "enforcePasswordExpiration": true, "enforceStrongPasswords": true, "enforceTwoFactorAuth": true, "idleTimeoutMinutes": 0, "loginIpRanges": ["string"], "minimumPasswordLength": 0, "numDifferentPasswords": 0, "passwordExpirationDays": 0}

Авторы

Francisco Munoz (@fmunoz)

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

© 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/meraki/organizations_login_security_module.html