fortinet.fortimanager.fmgr_system_admin_user модуль — Администратор пользователя.

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_user.

Новое в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation булево	Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия завершения работы с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия успешного завершения.
state строка / обязательный	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_admin_user словарь	Установленные параметры верхнего уровня.
adom список / элементы=словарь	ADOM.
adom-name строка	Устаревшее, переименуйте на adom_name. Имена административных доменов.
adom-access строка	Устаревшее, переименуйте на adom_access. Установка режима доступа к ADOM: все/указать/исключить. все — Доступ ко всем ADOM. указать — Указать доступ к ADOM. исключить — Исключить доступ к ADOM. Варианты: `"all"` `"specify"` `"exclude"` `"per-adom-profile"`
adom-exclude список / элементы=словарь	Устаревшее, переименуйте на adom_exclude. Исключение ADOM.
adom-name строка	Устаревшее, переименуйте на adom_name. Имена административных доменов.
app-filter список / элементы=словарь	Устаревшее, переименуйте на app_filter. Фильтр приложений.
app-filter-name строка	Устаревшее, переименуйте на app_filter_name. Имя фильтра приложений.
avatar строка	Изображение для аватара
ca строка	Сертификат CA пользователя PKI
change-password строка	Устаревшее, переименуйте на change_password. Включение/выключение возможности смены пароля ограниченным пользователем. отключить — Отключение параметра. включить — Включение параметра. Варианты: `"disable"` `"enable"`
cors-allow-origin строка	Устаревшее, переименуйте на cors_allow_origin. Access-Control-Allow-Origin.
dashboard список / элементы=словарь	Дэшборд.

column integer	Идентификатор столбца виджетов.
diskio-content-type string	Устарело, переименуйте в diskio_content_type. Тип диаграммы виджетов монитора дискового ввода-вывода. util - использование полосы пропускания. iops - количество запросов ввода-вывода. blks - объем данных запросов ввода-вывода. Choices: `"util"` `"iops"` `"blks"`
diskio-period string	Устарело, переименуйте в diskio_period. Период данных виджетов монитора дискового ввода-вывода. 1hour - 1 час. 8hour - 8 часов. 24hour - 24 часа. Choices: `"1hour"` `"8hour"` `"24hour"`
log-rate-period string	Устарело, переименуйте в log_rate_period. Период данных виджетов монитора приема журналов. 2min - 2 минуты. 1hour - 1 час. 6hours - 6 часов. Choices: `"2min"` `"1hour"` `"6hours"`
log-rate-topn string	Устарело, переименуйте в log_rate_topn. Количество отображаемых лучших элементов в виджетах монитора приема журналов. 1 - Лучший 1. 2 - Лучшие 2. 3 - Лучшие 3. 4 - Лучшие 4. 5 - Лучшие 5. Choices: `"1"` `"2"` `"3"` `"4"` `"5"`
log-rate-type string	Устарело, переименуйте в log_rate_type. Параметры детализации статистики виджетов монитора приема журналов. log - Показать скорости приема журналов для каждого типа журнала. device - Показать скорости приема журналов для каждого устройства. Choices: `"log"` `"device"`
moduleid integer	Идентификатор виджета.
name string	Название виджета.
num-entries integer	Устарело, переименуйте в num_entries. Количество записей.
refresh-interval integer	Устарело, переименуйте в refresh_interval. Интервал обновления виджетов.
res-cpu-display string	Устарело, переименуйте в res_cpu_display. Тип отображения ЦП виджетов. average - Среднее использование ЦП. each - Использование каждого ЦП. Choices: `"average"` `"each"`
res-period string	Устарело, переименуйте в res_period. Период данных виджетов. 10min - Последние 10 минут. hour - Последний час. day - Последний день. Choices: `"10min"` `"hour"` `"day"`
res-view-type string	Устарело, переименуйте в res_view_type. Тип представления данных виджетов. real-time - Представление в реальном времени. history - Представление истории. Choices: `"real-time"` `"history"`
status string	Состояние виджетов (открыто/закрыто). close - Виджет закрыт. open - Виджет открыт. Choices: `"close"` `"open"`
tabid integer	Идентификатор вкладки, где отображается виджет.
time-period string	Устарело, переименуйте в time_period. Период данных виджетов монитора базы данных журналов. 1hour - 1 час. 8hour - 8 часов. 24hour - 24 часа. Choices: `"1hour"` `"8hour"` `"24hour"`

widget-type string	Устарело, пожалуйста, переименуйте в widget_type. Тип виджета. top-lograte - Монитор приема журналов. sysres - Системные ресурсы. sysinfo - Информация о системе. licinfo - Информация о лицензии. jsconsole - Консоль CLI. sysop - Работа узла. alert - Консоль сообщений оповещения. statistics - Статистика. rpteng - Движок отчетов. raid - Монитор дисков. logrecv - Принятые журналы/данные. devsummary - Сводка по устройствам. logdb-perf - Монитор производительности базы данных журналов. logdb-lag - Время задержки базы данных журналов. disk-io - Ввод/вывод дисков. log-rcvd-fwd - Монитор приема и пересылки журналов. Choices: `"top-lograte"` `"sysres"` `"sysinfo"` `"licinfo"` `"jsconsole"` `"sysop"` `"alert"` `"statistics"` `"rpteng"` `"raid"` `"logrecv"` `"devsummary"` `"logdb-perf"` `"logdb-lag"` `"disk-io"` `"log-rcvd-fwd"`
dashboard-tabs list / elements=dictionary	Устарело, пожалуйста, переименуйте в dashboard_tabs. Вкладки панели мониторинга.
name string	Имя вкладки.
tabid integer	ID вкладки.
description string	Описание.
dev-group string	Устарело, пожалуйста, переименуйте в dev_group. Группа устройств.
email-address string	Устарело, пожалуйста, переименуйте в email_address. Адрес электронной почты.
ext-auth-accprofile-override string	Устарело, пожалуйста, переименуйте в ext_auth_accprofile_override. Разрешить использование профиля доступа, предоставленного удаленным сервером аутентификации. disable - Отключить переопределение профиля доступа. enable - Включить переопределение профиля доступа. Choices: `"disable"` `"enable"`
ext-auth-adom-override string	Устарело, пожалуйста, переименуйте в ext_auth_adom_override. Разрешить использование ADOM, предоставленного удаленным сервером аутентификации. disable - Отключить переопределение ADOM. enable - Включить переопределение ADOM. Choices: `"disable"` `"enable"`
ext-auth-group-match string	Устарело, пожалуйста, переименуйте в ext_auth_group_match. Только администраторы, принадлежащие к этой группе, могут войти в систему.
fingerprint string	Отпечаток сертификата пользователя PKI
first-name string	Устарело, пожалуйста, переименуйте в first_name. Имя.
force-password-change string	Устарело, пожалуйста, переименуйте в force_password_change. Включить/отключить принудительную смену пароля при следующем входе. disable - Отключить настройку. enable - Включить настройку. Choices: `"disable"` `"enable"`
fortiai string	Включить/отключить FortiAI. disable - Отключить настройку. enable - Включить настройку. Choices: `"disable"` `"enable"`
group string	Имя группы.
hidden integer	Скрытый администратор.
ips-filter list / elements=dictionary	Устарело, пожалуйста, переименуйте в ips_filter. Фильтр IPS.
ips-filter-name string	Устарело, пожалуйста, переименуйте в ips_filter_name. Имя фильтра IPS.
ipv6_trusthost1 string	Доверенный узел администратора IPv6, значение по умолчанию
ipv6_trusthost10 string	Доверенный узел администратора IPv6, значение по умолчанию ffff

ipv6_trusthost2 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost3 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost4 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost5 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost6 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost7 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost8 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
ipv6_trusthost9 string	Доверенный хост IPv6 пользователя администратора, по умолчанию ffff
last-name string	Устарело, переименуйте в last_name. Фамилия.
ldap-server string	Устарело, переименуйте в ldap_server. Имя LDAP-сервера.
login-max integer	Устарело, переименуйте в login_max. Максимальное количество сеансов входа для этого пользователя.
meta-data list / elements=dictionary	Устарело, переименуйте в meta_data. Метаданные.
fieldlength integer	Длина поля.
fieldname string	Имя поля.
fieldvalue string	Значение поля.
importance string	Важность. optional - Это поле является необязательным. required - Это поле является обязательным. Варианты: `"optional"` `"required"`
status string	Статус. disabled - Это поле отключено. enabled - Это поле включено. Варианты: `"disabled"` `"enabled"`
mobile-number string	Устарело, переименуйте в mobile_number. Номер мобильного телефона.
pager-number string	Устарело, переименуйте в pager_number. Номер пейджера.
password any	(list) Пароль.
password-expire any	(list or str) Устарело, переименуйте в password_expire. Время истечения срока действия пароля в GMT.
phone-number string	Устарело, переименуйте в phone_number. Номер телефона.
policy-block list / elements=dictionary	Устарело, переименуйте в policy_block. Блок политик.
policy-block-name string	Устарело, переименуйте в policy_block_name. Имена блоков политик.

policy-package список / элементы=словарь	Устарело, пожалуйста, переименуйте на policy_package. Политика пакета.
policy-package-name строка	Устарело, пожалуйста, переименуйте на policy_package_name. Имена пакетов политики.
profileid строка	Идентификатор профиля.
radius_server строка	Имя сервера RADIUS.
restrict-access строка	Устарело, пожалуйста, переименуйте на restrict_access. Включить/выключить ограниченный доступ к VDOM разработки. disable - Выключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
restrict-dev-vdom список / элементы=словарь	Устарело, пожалуйста, переименуйте на restrict_dev_vdom. Ограничить VDOM разработки.
dev-vdom строка	Устарело, пожалуйста, переименуйте на dev_vdom. Устройство или VDOM устройства.
rpc-permit строка	Устарело, пожалуйста, переименуйте на rpc_permit. установить none/read/read-write rpc-разрешение. read-write - Разрешение на чтение и запись. none - Нет разрешения. read - Разрешение на чтение. Варианты: `"read-write"` `"none"` `"read"` `"from-profile"`
ssh-public-key1 любой	(список) Устарело, пожалуйста, переименуйте на ssh_public_key1. Открытый ключ SSH 1.
ssh-public-key2 любой	(список) Устарело, пожалуйста, переименуйте на ssh_public_key2. Открытый ключ SSH 2.
ssh-public-key3 любой	(список) Устарело, пожалуйста, переименуйте на ssh_public_key3. Открытый ключ SSH 3.
subject строка	Ограничения имени сертификата пользователя PKI.
tacacs-plus-server строка	Устарело, пожалуйста, переименуйте на tacacs_plus_server. Имя сервера TACACS+.
th-from-profile целое число	Устарело, пожалуйста, переименуйте на th_from_profile. Только для внутреннего использования
th6-from-profile целое число	Устарело, пожалуйста, переименуйте на th6_from_profile. Только для внутреннего использования
trusthost1 строка	IP доверенного хоста администратора пользователя, по умолчанию 0.
trusthost10 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost2 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost3 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost4 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost5 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost6 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost7 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.
trusthost8 строка	IP доверенного хоста администратора пользователя, по умолчанию 255.

trusthost9 строка	IP-адрес доверенного хоста администратора пользователя, по умолчанию 255.
two-factor-auth строка	Устарело, пожалуйста, переименуйте его в two_factor_auth. Включить двухфакторную аутентификацию disable - Отключить двухфакторную аутентификацию. enable - Включить двухфакторную аутентификацию. Варианты: `"disable"` `"enable"` `"password"` `"ftc-ftm"` `"ftc-email"` `"ftc-sms"`
use-global-theme строка	Устарело, пожалуйста, переименуйте его в use_global_theme. Включить/отключить глобальную тему для администрирования GUI. disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
user-theme строка	Устарело, пожалуйста, переименуйте его в user_theme. Схема цветов для использования в GUI администратора пользователя. blue - Черешня green - Киви red - Вишня melongene - Слива spring - Весна summer - Лето autumn - Осень winter - Зима circuit-board - Схема печатной платы calla-lily - Калла binary-tunnel - Бинарный туннель mars - Марс blue-sea - Голубое море technology - Технология landscape - Ландшафт twilight - Сумерки canyon - Каньон northern-light - Северное сияние astronomy - Астрономия fish - Рыба penguin - Пингвин mountain - Гора panda - Панда parrot - Попугай cave - Пещера zebra - Зебра contrast-dark - Высокий контраст Темный Варианты: `"blue"` `"green"` `"red"` `"melongene"` `"spring"` `"summer"` `"autumn"` `"winter"` `"circuit-board"` `"calla-lily"` `"binary-tunnel"` `"mars"` `"blue-sea"` `"technology"` `"landscape"` `"twilight"` `"canyon"` `"northern-light"` `"astronomy"` `"fish"` `"penguin"` `"mountain"` `"panda"` `"parrot"` `"cave"` `"zebra"` `"contrast-dark"` `"mariner"` `"jade"` `"neutrino"` `"dark-matter"` `"forest"` `"cat"` `"graphite"`
user_type строка	Тип пользователя. local - Местный пользователь. radius - Пользователь RADIUS. ldap - Пользователь LDAP. tacacs-plus - Пользователь TACACS+. pki-auth - Пользователь PKI. group - Пользователь группы. Варианты: `"local"` `"radius"` `"ldap"` `"tacacs-plus"` `"pki-auth"` `"group"` `"sso"` `"api"`
userid строка / обязательно	Имя пользователя.
web-filter список / элементы=словарь	Устарело, пожалуйста, переименуйте его в web_filter. Веб-фильтр.
web-filter-name строка	Устарело, пожалуйста, переименуйте его в web_filter_name. Имя веб-фильтра.
wildcard строка	Включить/отключить поддержку подстановочных символов для удаленной аутентификации. disable - Отключить подстановочные символы в имени пользователя. enable - Включить подстановочные символы в имени пользователя. Варианты: `"disable"` `"enable"`
workspace_locking_adom строка	Область (ADOM), которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства. Значение может быть global и другими, включая 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_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Admin User
      fortinet.fortimanager.fmgr_system_admin_user:
        state: present
        system_admin_user:
          adom:
            - adom-name: ansible
          userid: "ansible-test"
    - name: Admin domain.
      fortinet.fortimanager.fmgr_system_admin_user_adom:
        bypass_validation: false
        user: ansible-test # userid
        state: present
        system_admin_user_adom:
          adom-name: "ALL ADOMS"

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

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

Ключ	Описание
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_system_admin_user_module.html