fmgr_system_interface_obj – Interface configuration.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [delete, get, set, update] the following FortiManager json-rpc urls.
- /cli/global/system/interface/{interface}
- 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.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way 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 dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- interface - the object name type: str
- parameters for method: [delete, get] - Interface configuration.
- parameters for method: [set, update] - Interface configuration.
- data - No description for the parameter type: dict
- alias - Alias. type: str
- allowaccess - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [ping, https, ssh, snmp, http, webservice, https-logging]
- description - Description. type: str
- ip - IP address of interface. type: str default: 0.0.0.0 0.0.0.0
- ipv6
- ip6-address - IPv6 address/prefix of interface. type: str default: ::/0
- ip6-allowaccess - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [ping, https, ssh, snmp, http, webservice, https-logging]
- ip6-autoconf - Enable/disable address auto config (SLAAC). type: str choices: [disable, enable] default: enable
- mtu - Maximum transportation unit(68 - 9000). type: int default: 1500
- name - Interface name. type: str
- serviceaccess - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [fgtupdates, fclupdates, webfilter-antispam]
- speed - Speed. type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 10000full] default: auto
- status - Interface status. type: str choices: [down, up] default: up
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
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: REQUESTING /CLI/SYSTEM/INTERFACE/{INTERFACE}
fmgr_system_interface_obj:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [set, update]>
url_params:
interface: <value of string>
params:
-
data:
alias: <value of string>
allowaccess:
- <value in [ping, https, ssh, ...]>
description: <value of string>
ip: <value of string>
ipv6:
ip6-address: <value of string>
ip6-allowaccess:
- <value in [ping, https, ssh, ...]>
ip6-autoconf: <value in [disable, enable]>
mtu: <value of integer>
name: <value of string>
serviceaccess:
- <value in [fgtupdates, fclupdates, webfilter-antispam]>
speed: <value in [auto, 10full, 10half, ...]>
status: <value in [down, up]>
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:
- return values for method: [delete, set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /cli/global/system/interface/{interface}
- return values for method: [get]
- data
- No description for the parameter type: dict
- alias - Alias. type: str
- allowaccess - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- description - Description. type: str
- ip - IP address of interface. type: str example: 0.0.0.0 0.0.0.0
- ipv6
- ip6-address - IPv6 address/prefix of interface. type: str example: ::/0
- ip6-allowaccess - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- ip6-autoconf - Enable/disable address auto config (SLAAC). type: str example: enable
- mtu - Maximum transportation unit(68 - 9000). type: int example: 1500
- name - Interface name. type: str
- serviceaccess - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- speed - Speed. type: str example: auto
- status - Interface status. type: str example: up
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /cli/global/system/interface/{interface}