Модуль fortinet.fortimanager.fmgr_rename — переименование объекта в FortiManager.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_rename.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager, переименовав объект.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Токен доступа для пользователей API, управляемых FortiCloud. Этот параметр доступен в FortiManager версии выше 6.4.0. |
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия, при которых задача считается неудачной. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия, при которых задача считается выполненной успешно. |
rename dictionary / обязательный | Переименование объекта. |
|
selector string / обязательный |
Селектор переименовываемого объекта. Варианты:
|
|
self dictionary / обязательный |
Параметр для каждого селектора. |
|
target dictionary / обязательный |
Атрибут, который необходимо переопределить для целевого объекта. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global и другие, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой, если возвращается ненулевой код rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Rename an object
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Rename a vip object using fmgr_rename module.
fortinet.fortimanager.fmgr_rename:
rename:
selector: "firewall_vip"
self:
adom: "root"
vip: "ansible-test-vip_first"
target:
name: "ansible-test-vip_fourth"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL-адрес запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус API-запроса. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_rename_module.html