fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpuser модуль – Способ конфигурации для редактирования протокола Simple Network Management Protocol

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Новое в fortinet.fortimanager 2.1.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить для источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логический тип	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический тип	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью маркера доступа к API forticloud.
managed-switch строка	Устарело, используйте «managed_switch»
managed_switch строка	Параметр (managed-switch) в запрошенном URL.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для успешного выполнения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_managedswitch_snmpuser словарь	Настройка параметров верхнего уровня.
auth-proto строка	Устарело, пожалуйста, переименуйте в auth_proto. Протокол аутентификации. Варианты: `"md5"` `"sha"`
auth-pwd любой тип	(список) Устарело, пожалуйста, переименуйте в auth_pwd. Пароль для протокола аутентификации.
name строка / обязательно	Имя пользователя SNMP.
priv-proto строка	Устарело, пожалуйста, переименуйте в priv_proto. Конфиденциальность Варианты: `"des"` `"aes"`
priv-pwd любой тип	(список) Устарело, пожалуйста, переименуйте в priv_pwd. Пароль для конфиденциальности
queries строка	Включить/выключить запросы SNMP для этого пользователя. Варианты: `"disable"` `"enable"`
query-port целое число	Устарело, пожалуйста, переименуйте в query_port. Порт запроса SNMPv3
security-level строка	Устарело, пожалуйста, переименуйте в security_level. Уровень безопасности для проверки подлинности сообщений и шифрования. Варианты: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`

END_OF_DOCUMENT_MARKER

workspace_locking_adom строка	ADOM для блокировки в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют имя, использующее соглашение об именовании с подчёркиваниями (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается запуск в режиме блокировки рабочего пространства. Параметры workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configuration method to edit Simple Network Management Protocol
      fortinet.fortimanager.fmgr_switchcontroller_managedswitch_snmpuser:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        managed_switch: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_managedswitch_snmpuser:
          auth_proto: <value in [md5, sha]>
          auth_pwd: <list or string>
          name: <string>
          priv_proto: <value in [des, aes]>
          priv_pwd: <list or string>
          queries: <value in [disable, enable]>
          query_port: <integer>
          security_level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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/fortinet/fortimanager/fmgr_switchcontroller_managedswitch_snmpuser_module.html