fortinet.fortimanager.fmgr_securityconsole_install_package module – Copy and install a policy package to devices.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Source ADOM name. |
|
If generate_rev flag is set, the comment for the new ADOM revision. |
|
If generate_rev flag is set, the name for the new ADOM revision. |
|
Comments for the device configuration revision that will be generated during install. |
|
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:
|
|
Source package path and name. |
|
Scope. |
|
Name. |
|
Vdom. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook
hosts: fortimanagers
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: fmg
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 }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |