fortinet.fortimanager.fmgr_cifs_profile модуль — Настройка профиля CIFS.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
cifs_profile словарь	Установленные параметры верхнего уровня.
domain_controller строка	Устаревшее значение, переименуйте на domain_controller. Домен, для которого необходимо расшифровать трафик CIFS.
file_filter словарь	Устаревшее значение, переименуйте на file_filter. Фильтр файлов.
entries список / элементы=словарь	Элементы списка.
action строка	Действие, выполняемое для сопоставленного файла. Варианты: `"block"` `"log"`
comment строка	Комментарий.
direction строка	Сопоставление файлов, передаваемых в сеансах исходящего или ответного направления. Варианты: `"incoming"` `"outgoing"` `"any"`
file_type любой	(список или строка) Устаревшее значение, переименуйте на file_type. Выбор типа файла.
filter строка	Добавить фильтр файлов.
protocol список / элементы=строка	Протоколы для применения. Варианты: `"cifs"`
log строка	Включить/выключить ведение журнала для фильтра файлов. Варианты: `"disable"` `"enable"`
status строка	Включить/выключить фильтр файлов. Варианты: `"disable"` `"enable"`
name строка / обязательно	Имя профиля.
server_credential_type строка	Тип аутентификации сервера CIFS. Варианты: `"none"` `"credential-replication"` `"credential-keytab"`
server_keytab список / элементы=словарь	Серверный ключ.
keytab строка	Ключ сервера, закодированный в Base64.
password любой	(список) Пароль для ключа.
principal строка	Основной элемент.
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"`
workspace_locking_adom строка	Область (adom) для блокировки в режиме работы FortiManager в рабочем пространстве; значение может быть глобальным и другими, включая корневой.
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: Configure CIFS profile.
      fortinet.fortimanager.fmgr_cifs_profile:
        # 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]>
        cifs_profile:
          domain_controller: <string>
          name: <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 словарь	Результат запроса. Возвращается: всегда
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_cifs_profile_module.html