Модуль fortinet.fortimanager.fmgr_user_group_dynamicmapping_guest – Пользователь гостя.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_user_group_dynamicmapping_guest.
Новое в fortinet.fortimanager 2.1.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
dynamic_mapping строка / обязательно | Параметр (dynamic_mapping) в запрошенном URL. |
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с токеном доступа к API forticloud. |
group строка / обязательно | Параметр (group) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
user_group_dynamicmapping_guest словарь | Настроены параметры верхнего уровня. |
|
comment строка |
Комментарий. |
|
company строка |
Установить действие для поля компании гостевого пользователя. |
|
строка |
Электронная почта. |
|
expiration строка |
Время истечения. |
|
group строка |
Группа. |
|
id целое число / обязательно |
Идентификатор гостя. |
|
mobile_phone строка |
Устарело, пожалуйста, переименуйте на mobile_phone. Мобильный телефон. |
|
name строка |
Имя гостя. |
|
password любой тип |
(список) Пароль гостя. |
|
sponsor строка |
Установить действие для поля спонсора гостевого пользователя. |
|
user_id строка |
Устарело, пожалуйста, переименуйте на user_id. Идентификатор гостя. |
workspace_locking_adom string | ADOM для блокировки в режиме работы в пространстве FortiManager, значение может быть глобальным и другими, включая корень. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Guest User.
fortinet.fortimanager.fmgr_user_group_dynamicmapping_guest:
# 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>
group: <your own value>
dynamic_mapping: <your own value>
state: present # <value in [present, absent]>
user_group_dynamicmapping_guest:
comment: <string>
company: <string>
email: <string>
expiration: <string>
group: <string>
id: <integer>
mobile_phone: <string>
name: <string>
password: <list or string>
sponsor: <string>
user_id: <string>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Справочные ссылки на сборку
© 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_user_group_dynamicmapping_guest_module.html
