модуль fortinet.fortimanager.fmgr_switchcontroller_dsl_policy — политика DSL.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_dsl_policy.

Добавлено в fortinet.fortimanager 2.1.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, который переопределяет условия неудачного выполнения.
rc_succeeded list / элементы=integer	Список кодов rc, который переопределяет условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Инструкция по созданию, обновлению или удалению объекта. Варианты: `"present"` `"absent"`
switchcontroller_dsl_policy dictionary	Набор параметров верхнего уровня.
append_padding string	Конфигурация паузы кадров устройства. Варианты: `"disable"` `"enable"`
cpe_aele псевдонимы: cpe-aele string	AELE CPE. Варианты: `"disable"` `"enable"`
cpe_aele_mode псевдонимы: cpe-aele-mode string	Режим AELE CPE с заданной строкой. Варианты: `"ELE_M0"` `"ELE_DS"` `"ELE_PB"` `"ELE_MIN"`
cs list / элементы=string	Набор несущих CPE. Варианты: `"A43"` `"B43"` `"A43C"` `"V43"`
ds_bitswap псевдонимы: ds-bitswap string	Включить/отключить bitswap. Варианты: `"disable"` `"enable"`
name string / обязательный	Имя политики.
pause_frame псевдонимы: pause-frame string	Конфигурация паузы кадров устройства. Варианты: `"disable"` `"enable"`
profile string	Профиль VDSL CPE. Варианты: `"auto-30a"` `"auto-17a"` `"auto-12ab"`
type string	Тип. Варианты: `"Procend"` `"Proscend"`
us_bitswap псевдонимы: us-bitswap string	Включить/отключить bitswap. Варианты: `"disable"` `"enable"`
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.
Как правило, выполнение модуля завершается ошибкой, если возвращается ненулевой код 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: DSL policy.
      fortinet.fortimanager.fmgr_switchcontroller_dsl_policy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_dsl_policy:
          name: "your value" # Required variable, string
          # append_padding: <value in [disable, enable]>
          # cpe_aele: <value in [disable, enable]>
          # cpe_aele_mode: <value in [ELE_M0, ELE_DS, ELE_PB, ...]>
          # cs: ["A43", "B43", "A43C", "V43"]
          # ds_bitswap: <value in [disable, enable]>
          # pause_frame: <value in [disable, enable]>
          # profile: <value in [auto-30a, auto-17a, auto-12ab]>
          # type: <value in [Procend, Proscend]>
          # us_bitswap: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_dsl_policy_module.html