fortinet.fortimanager.fmgr_switchcontroller_customcommand – Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices.
This plugin is part of the fortinet.fortimanager collection (version 2.1.4).
You might already have this collection installed if you are using the
It is not included in
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:
New in version 2.10: of fortinet.fortimanager
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.
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.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
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
- hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices. fmgr_switchcontroller_customcommand: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> switchcontroller_customcommand: command: <value of string> command-name: <value of string> description: <value of string>
Common return values are documented here, the following are the fields unique to this module:
The full url requested
The status of api request
The descriptive message of the api response