модуль fortinet.fortimanager.fmgr_cifs_profile — настройка профиля CIFS.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_cifs_profile.
Добавлено в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
cifs_profile dictionary | Параметры верхнего уровня. |
|
domain_controller псевдонимы: domain-controller string |
Домен, трафик CIFS которого необходимо расшифровывать. |
|
file_filter псевдонимы: file-filter dictionary |
Фильтр файлов. |
|
entries list / элементы=dictionary |
Записи. |
|
action string |
Действие, выполняемое для совпавшего файла. Варианты:
|
|
comment string |
Комментарий. |
|
direction string |
Сопоставлять файлы, передаваемые в исходном или ответном направлении сеанса. Варианты:
|
|
file_type псевдонимы: file-type any |
(список или строка) Выберите тип файла. |
|
filter string |
Добавить фильтр файлов. |
|
protocol list / элементы=string |
Протоколы, к которым применяется настройка. Варианты:
|
|
log string |
Включить или отключить ведение журнала для фильтра файлов. Варианты:
|
|
status string |
Включить или отключить фильтр файлов. Варианты:
|
|
name string / обязательный |
Имя профиля. |
|
server_credential_type псевдонимы: server-credential-type string |
Тип учетных данных сервера CIFS. Варианты:
|
|
server_keytab псевдонимы: server-keytab list / элементы=dictionary |
Keytab сервера. |
|
keytab string |
Файл keytab в кодировке Base64, содержащий учетные данные сервера. |
|
password any |
(список) Пароль для keytab. |
|
principal string |
Имя субъекта-службы. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, которыми переопределяются условия неудачного выполнения. |
rc_succeeded list / элементы=integer | Список кодов rc, которыми переопределяются условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая 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.
- Как правило, выполнение модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure CIFS profile.
fortinet.fortimanager.fmgr_cifs_profile:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
cifs_profile:
name: "your value" # Required variable, string
# domain_controller: <string>
# server_credential_type: <value in [none, credential-replication, credential-keytab]>
# server_keytab:
# - keytab: <string>
# principal: <string>
# password: <list or string>
# file_filter:
# entries:
# - action: <value in [block, log]>
# comment: <string>
# direction: <value in [incoming, outgoing, any]>
# file_type: <list or string>
# filter: <string>
# protocol: ["cifs"]
# log: <value in [disable, enable]>
# status: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложном результате |
Ссылки на коллекцию
© 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/fortinet/fortimanager/fmgr_cifs_profile_module.html