drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_securityconsole_install_device no description | "added in version" 1.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_securityconsole_install_device (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- name: Commit config to real device hosts: fortimanager01 gather_facts: no connection: httpapi collections: - fortinet.fortimanager vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 device_adom: 'root' script_name: 'FooScript' device_name: 'CustomHostName' device_vdom: 'root' tasks: - name: invoke the task fmgr_securityconsole_install_device: securityconsole_install_device: adom: '{{ device_adom }}' scope: - name: '{{ device_name }}' vdom: '{{ device_vdom }}' register: installing_task - name: Inspect the Task Status fmgr_fact: facts: selector: 'task_task' params: task: '{{installing_task.meta.response_data.task}}' register: taskinfo until: taskinfo.meta.response_data.percent == 100 retries: 30 delay: 3 failed_when: taskinfo.meta.response_data.state == 'error'
- hosts: fortimanager00 collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: fmgr_securityconsole_install_device: bypass_validation: False securityconsole_install_device: adom: ansible dev_rev_comments: ansible-comment flags: - none - preview - auto_lock_ws scope: - name: ansible-test vdom: root
rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int securityconsole_install_device: description: the top level parameters set required: false suboptions: adom: description: Source ADOM name. type: str dev_rev_comments: description: no description type: str flags: choices: - none - preview - auto_lock_ws description: description elements: str type: list scope: description: description elements: dict suboptions: name: description: no description type: str vdom: description: no description type: str type: list type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list