Модуль fortinet.fortimanager.fmgr_application_internetservicecustom – Настройка пользовательских приложений интернет-сервисов.

Примечание

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

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

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

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_application_internetservicecustom.

Новое в fortinet.fortimanager 2.2.0

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
application_internetservicecustom dictionary	Набор параметров верхнего уровня.
comment string	Комментарий.
disable-entry list / elements=dictionary	Устарело, переименуйте в disable_entry. Отключить запись.
id integer	ID отключаемой записи.
ip-range list / elements=dictionary	Устарело, переименуйте в ip_range. Диапазон IP-адресов.
end-ip string	Устарело, переименуйте в end_ip. Конечный IP-адрес.
id integer	ID диапазона отключаемых записей.
start-ip string	Устарело, переименуйте в start_ip. Начальный IP-адрес.
port any	(list) Порт.
protocol integer	Номер протокола.
entry list / elements=dictionary	Запись.
dst string	Имя адреса назначения.
id integer	ID записи
port-range list / elements=dictionary	Устарело, переименуйте в port_range. Диапазон портов.
end-port integer	Устарело, переименуйте в end_port. Конечный номер порта назначения
id integer	ID диапазона портов пользовательской записи.
start-port integer	Устарело, переименуйте в start_port. Начальный номер порта назначения
protocol integer	Номер протокола.
master-service-id string	Устарело, переименуйте в master_service_id. ID приложения базы данных интернет-сервиса.
name string / required	Имя приложения.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`

enable_log boolean	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
forticloud_access_token string	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия неудачи.
rc_succeeded list / elements=integer	Список кодов rc, с которыми будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager в режиме рабочей области, значение может быть global и другие, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: `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 custom Internet service applications.
      fortinet.fortimanager.fmgr_application_internetservicecustom:
        # 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]>
        application_internetservicecustom:
          comment: <string>
          disable_entry:
            -
              id: <integer>
              ip_range:
                -
                  end_ip: <string>
                  id: <integer>
                  start_ip: <string>
              port: <list or integer>
              protocol: <integer>
          entry:
            -
              dst: <string>
              id: <integer>
              port_range:
                -
                  end_port: <integer>
                  id: <integer>
                  start_port: <integer>
              protocol: <integer>
          master_service_id: <string>
          name: <string>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL-адрес запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_application_internetservicecustom_module.html