Note
This module is part of the fortinet.fortimanager collection (version 2.10.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_securityconsole_install_package.
New in fortinet.fortimanager 1.0.0
Parameter | Comments |
|---|---|
access_token string | The token to access FortiManager without using username and password. |
bypass_validation boolean | Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
enable_log boolean | Enable/Disable logging for task. Choices:
|
forticloud_access_token string | Authenticate Ansible client with forticloud API access token. |
rc_failed list / elements=integer | The rc codes list with which the conditions to fail will be overriden. |
rc_succeeded list / elements=integer | The rc codes list with which the conditions to succeed will be overriden. |
securityconsole_install_package dictionary | The top level parameters set. |
|
adom string |
Source ADOM name. |
|
adom_rev_comments string |
If generate_rev flag is set, the comment for the new ADOM revision. |
|
adom_rev_name string |
If generate_rev flag is set, the name for the new ADOM revision. |
|
dev_rev_comments string |
Comments for the device configuration revision that will be generated during install. |
|
flags list / elements=string |
cp_all_objs - Assign all objects during global policy assignment. preview - Generate preview cache only. generate_rev - Generate new ADOM revision before install. copy_assigned_pkg - For global policy assignment - copy assigned package from ADOM to device. unassign - Remove global policy from ADOM. ifpolicy_only - Only install interface policies. no_ifpolicy - Install regular policies only - do not install interface policies. objs_only - Install object auto_lock_ws - Automatically lock and unlock workspace when performing security console task. copy_only - Only copy to device db. Choices:
|
|
pkg string |
Source package path and name. |
|
scope list / elements=dictionary |
Scope. |
|
name string |
Name. |
|
vdom string |
Vdom. |
workspace_locking_adom string | The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
workspace_locking_timeout integer | The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Note
- name: Example playbook
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Copy and install a policy package to devices.
fortinet.fortimanager.fmgr_securityconsole_install_package:
bypass_validation: false
securityconsole_install_package:
adom: ansible
adom_rev_comments: ansible-comment
adom_rev_name: ansible-test
dev_rev_comments: ansible-comment
flags:
- none
- cp_all_objs
- preview
- generate_rev
- copy_assigned_pkg
- unassign
- ifpolicy_only
- no_ifpolicy
- objs_only
- auto_lock_ws
- check_pkg_st
- copy_only
pkg: ansible
scope:
- name: Ansible-test
vdom: root
- name: INSTALL PREVIEW - POLICY PACKAGE
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
adom: demo
ppkg: ppkg_hubs
device: fgt_00_1
tasks:
- name: Install for policy package [preview mode] {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_install_package:
securityconsole_install_package:
adom: "{{ adom }}"
flags:
- preview
pkg: "{{ ppkg }}"
scope:
- name: "{{ device }}"
vdom: root
register: r
- name: Poll the task
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ r.meta.response_data.task }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 5
- name: Trigger the preview report generation for policy package {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_install_preview:
securityconsole_install_preview:
adom: "{{ adom }}"
device: "{{ device }}"
flags:
- json
vdoms: root
register: r
- name: Poll the task
fortinet.fortimanager.fmgr_fact:
facts:
selector: "task_task"
params:
task: "{{ r.meta.response_data.task }}"
register: taskinfo
until: taskinfo.meta.response_data.percent == 100
retries: 30
delay: 5
- name: Get the preview report for policy package {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_preview_result:
securityconsole_preview_result:
adom: "{{ adom }}"
device: "{{ device }}"
register: r
- name: Cancel install task for policy package {{ ppkg }}
fortinet.fortimanager.fmgr_securityconsole_package_cancel_install:
securityconsole_package_cancel_install:
adom: "{{ adom }}"
- name: Show preview report
ansible.builtin.debug:
msg: "{{ r }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
meta dictionary | The result of the request. Returned: always |
|
request_url string |
The full url requested. Returned: always Sample: |
|
response_code integer |
The status of api request. Returned: always Sample: |
|
response_data list / elements=string |
The api response. Returned: always |
|
response_message string |
The descriptive message of the api response. Returned: always Sample: |
|
system_information dictionary |
The information of the target system. Returned: always |
rc integer | The status the request. Returned: always Sample: |
version_check_warning list / elements=string | Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_securityconsole_install_package_module.html