fmgr_system_interface – Interface configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
|
| system_interface | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- system_interface - Interface configuration. type: dict
- alias - Alias. type: str more...
- allowaccess - No description for the parameter type: array choices: [ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, soc-fabric, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, soc-fabric, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, soc-fabric, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, ping, https, ssh, snmp, http, webservice, https-logging, soc-fabric] more...
- description - Description. type: str more...
- ip - IP address of interface. type: str default: 0.0.0.0 0.0.0.0 more...
- ipv6 type: dict
- ip6-address - IPv6 address/prefix of interface. type: str default: ::/0 more...
- ip6-allowaccess - No description for the parameter type: array choices: [ping, https, ssh, snmp, http, webservice, https-logging] more...
- ip6-autoconf - Enable/disable address auto config (SLAAC). type: str choices: [disable, enable] default: enable more...
- mtu - Maximum transportation unit(68 - 9000). type: int default: 1500 more...
- name - Interface name. type: str more...
- serviceaccess - No description for the parameter type: array choices: [fgtupdates, fclupdates, webfilter-antispam] more...
- speed - Speed. type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 10000full] default: auto more...
- status - Interface status. type: str choices: [down, up] default: up more...
- rating-service-ip - IP address for fgt rating service, must be same subnet with interface ip. type: str default: 0.0.0.0 0.0.0.0 more...
- update-service-ip - IP address for fgt/fct update service, must be same subnet with interface ip. type: str default: 0.0.0.0 0.0.0.0 more...
Notes¶
Note
- 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
Examples¶
- 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: Interface configuration.
fmgr_system_interface:
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, ...]
state: <value in [present, absent]>
system_interface:
alias: <value of string>
allowaccess:
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- soc-fabric
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- soc-fabric
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- soc-fabric
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
- soc-fabric
description: <value of string>
ip: <value of string>
ipv6:
ip6-address: <value of string>
ip6-allowaccess:
- ping
- https
- ssh
- snmp
- http
- webservice
- https-logging
ip6-autoconf: <value in [disable, enable]>
mtu: <value of integer>
name: <value of string>
serviceaccess:
- fgtupdates
- fclupdates
- webfilter-antispam
speed: <value in [auto, 10full, 10half, ...]>
status: <value in [down, up]>
rating-service-ip: <value of string>
update-service-ip: <value of string>
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict