Модуль fortinet.fortios.fortios_system_alias – Настройка команды алиаса в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: fortinet.fortios.fortios_system_alias.
Добавлена в fortinet.fortios 2.0.0
Описание
- Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию алиасов. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерирован из графического интерфейса Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Выбранные значения:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов больше одного. Параметр, помеченный member_path, законен для выполнения операции над членами. |
member_state строка | Добавить или удалить члена по указанному пути атрибута. При указании member_state опция state игнорируется. Выбранные значения:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Выбранные значения:
|
system_alias словарь | Настройка команды алиаса. |
|
command строка |
Список команд для выполнения. |
|
name строка / обязательно |
Имя команды алиаса. |
vdom строка | Виртуальный домен, среди ранее определённых. VDOM — это виртуальная копия FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска книг задач
- Модуль поддерживает режим проверки.
Примеры
- name: Configure alias command.
fortinet.fortios.fortios_system_alias:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_alias:
command: "<your_own_value>"
name: "default_name_4"
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, полученный от FortiGate при последнем примененном действии Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_alias_module.html
