fortinet.fortimanager.fmgr_user_nsx модуль — Пользователь nsx
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_user_nsx.
Новая функция в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать согласно источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить логирование для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых условия завершения работы будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия успешного завершения работы будут переопределены. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
user_nsx словарь | Настройка верхнего уровня параметров. |
|
fmgip строка |
Fmgip. |
|
fmgpasswd любой тип |
(список) Fmgpasswd. |
|
fmguser строка |
Fmguser. |
|
if-allgroup строка |
Устарело, пожалуйста, переименуйте на if_allgroup. Если все группы. Варианты:
|
|
name строка / обязательно |
Имя. |
|
password любой тип |
(список) Пароль. |
|
server строка |
Сервер. |
|
service список / элементы=словарь |
Сервис. |
|
id строка |
Идентификатор. |
|
integration строка |
Интеграция. Варианты:
|
|
name строка |
Имя. |
|
ref-id строка |
Устарело, пожалуйста, переименуйте на ref_id. Идентификатор ссылки. |
|
service-id любой тип |
(список) Устарело, пожалуйста, переименуйте на service_id. Идентификатор сервиса. |
|
service-manager-id строка |
Устарело, пожалуйста, переименуйте на service_manager_id. Идентификатор управляющего сервиса. |
|
service-manager-rev integer |
Устаревший, пожалуйста, переименуйте его в service_manager_rev. Ревизия диспетчера служб. |
|
status string |
Статус. Выбираемые значения:
|
|
user string |
Пользователь. |
workspace_locking_adom string | ADOM для блокировки в режиме рабочего пространства FortiManager. Значение может быть глобальным и другими, включая root. |
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_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: User nsx
fortinet.fortimanager.fmgr_user_nsx:
# 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>
state: present # <value in [present, absent]>
user_nsx:
fmgip: <string>
fmguser: <string>
name: <string>
password: <list or string>
server: <string>
status: <value in [disable, enable]>
user: <string>
fmgpasswd: <list or string>
service_id: <list or string>
if_allgroup: <value in [disable, enable]>
service:
-
id: <string>
integration: <value in [east-west, north-south]>
name: <string>
ref_id: <string>
service_manager_id: <string>
service_manager_rev: <integer>
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_nsx_module.html
