Модуль fortinet.fortimanager.fmgr_system_sdnconnector_nic_ip – Настройка IP-конфигурации.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_sdnconnector_nic_ip.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только в случае расхождений схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
nic строка / обязательно	Параметр (nic) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия завершения задачи с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успешного завершения.
sdn-connector строка	Устарело, используйте «sdn_connector»
sdn_connector строка	Параметр (sdn-connector) в запрошенном URL.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_sdnconnector_nic_ip словарь	Настройка верхнего уровня параметров.
name строка / обязательно	Имя конфигурации IP.
public_ip строка	Устарело, переименуйте на public_ip. Имя публичного IP.
resource_group строка	Устарело, переименуйте на resource_group. Группа ресурсов Azure публичного IP.
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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IP configuration.
      fortinet.fortimanager.fmgr_system_sdnconnector_nic_ip:
        bypass_validation: false
        adom: ansible
        sdn-connector: ansible-test-sdn # name
        nic: ansible-test-nic # name
        state: present
        system_sdnconnector_nic_ip:
          name: ansible-test-nicip
          public-ip: 222.222.222.2

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IP configurations of Azure network interface
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_sdnconnector_nic_ip"
          params:
            adom: "ansible"
            sdn-connector: "ansible-test-sdn" # name
            nic: "ansible-test-nic" # name
            ip: "your_value"

Значения возврата

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

Ключ	Описание
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_system_sdnconnector_nic_ip_module.html