drmofu / drmofu.fortianalyzer / 1.3.0 / module / faz_cli_system_interface Interface configuration. | "added in version" 1.0.0 of drmofu.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortianalyzer.faz_cli_system_interface (1.3.0) — module
Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0
collections: - name: drmofu.fortianalyzer version: 1.3.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- collections: - fortinet.fortianalyzer connection: httpapi hosts: fortianalyzer_inventory tasks: - faz_cli_system_interface: state: present cli_system_interface: name: fooaggregate status: up type: aggregate - faz_cli_system_interface_member: cli_system_interface_member: interface-name: port4 interface: fooaggregate state: present name: Physical interfaces that belong to the aggregate or redundant interface. vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
- collections: - fortinet.fortianalyzer connection: httpapi hosts: fortianalyzer_inventory tasks: - faz_cli_system_interface: cli_system_interface: allowaccess: - ping - https - ssh - snmp - http - webservice - fgfm - https-logging - soc-fabric description: second port ip: 22.22.22.222 255.255.255.0 name: port2 status: down #type: physical state: present name: Interface configuration. vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
state: choices: - present - absent description: The directive to create, update or delete an object required: true type: str log_path: default: /tmp/fortianalyzer.ansible.log description: - The path to save log. Used if enable_log is true. - Please use absolute path instead of relative path. - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log required: false type: str 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 proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool cli_system_interface: description: the top level parameters set required: false suboptions: aggregate: description: Aggregate interface. type: str alias: description: Alias. type: str allowaccess: choices: - ping - https - ssh - snmp - http - webservice - fgfm - https-logging - soc-fabric - fabric description: no description elements: str type: list description: description: Description. type: str interface: description: Underlying interface name. type: str ip: description: IP address of interface. type: str ipv6: description: no description required: false suboptions: ip6-address: description: IPv6 address/prefix of interface. type: str ip6-allowaccess: choices: - ping - https - ssh - snmp - http - webservice - fgfm - https-logging - fabric description: no description elements: str type: list ip6-autoconf: choices: - disable - enable description: - Enable/disable address auto config (SLAAC). - disable - Disable setting. - enable - Enable setting. type: str type: dict lacp-mode: choices: - active description: - LACP mode. - active - Actively use LACP to negotiate 802.3ad aggregation. type: str lacp-speed: choices: - slow - fast description: - How often the interface sends LACP messages. - slow - Send LACP message every 30 seconds. - fast - Send LACP message every second. type: str link-up-delay: description: Number of milliseconds to wait before considering a link is up. type: int lldp: choices: - disable - enable description: - Enable/disable LLDP (Link Layer Discovery Protocol). - disable - Disable setting. - enable - Enable setting. type: str member: description: no description elements: dict suboptions: interface-name: description: Physical interface name. type: str type: list min-links: description: Minimum number of aggregated ports that must be up. type: int min-links-down: choices: - operational - administrative description: - Action to take when less than the configured minimum number of links are active. - operational - Set the aggregate operationally down. - administrative - Set the aggregate administratively down. type: str mtu: description: Maximum transportation unit(68 - 9000). type: int name: description: Interface name. type: str speed: choices: - auto - 10full - 10half - 100full - 100half - 1000full - 10000full - 1g/full - 2.5g/full - 5g/full - 10g/full - 14g/full - 20g/full - 25g/full - 40g/full - 50g/full - 56g/full - 100g/full - 1g/half description: - Speed. - auto - Auto adjust speed. - 10full - 10M full-duplex. - 10half - 10M half-duplex. - 100full - 100M full-duplex. - 100half - 100M half-duplex. - 1000full - 1000M full-duplex. - 10000full - 10000M full-duplex. type: str status: choices: - down - up - disable - enable description: - Interface status. - down - Interface down. - up - Interface up. type: str type: choices: - physical - aggregate - vlan description: - Set type of interface (physical/aggregate). - physical - Physical interface. - aggregate - Aggregate interface. type: str vlan-protocol: choices: - 8021q - 8021ad description: - Ethernet protocol of VLAN. - 8021q - IEEE 802.1Q. - 8021ad - IEEE 802.1AD. type: str vlanid: description: VLAN ID (1 - 4094). type: int type: dict forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
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 fortianalyzer version. returned: complex type: list