faz_cli_system_interface – Interface configuration.
New in version 1.0.0.
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
Possible variable names before 2.0.0:
variable-name
,variable name
,variable.name
Corresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiAnalyzer Version Compatibility
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
||
None | True | True | True | None | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
6.4.14 |
None | True | True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
7.0.11 |
|||
True | True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
||||||||||
True | True | True | True | True | ||||||||||
7.4.0 |
7.4.1 |
7.4.2 |
||||||||||||
True | True | True |
Parameters
- access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
- log_path - 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.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
- 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 FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- 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
- cli_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, fgfm, https-logging, soc-fabric, 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, fgfm, https-logging, fabric] 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...
- speed - Speed. type: str 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] default: auto more...
- status - Interface status. type: str choices: [down, up, disable, enable] default: up more...
- aggregate - Aggregate interface. type: str more...
- lacp_mode - LACP mode. type: str choices: [active] default: active more...
- lacp_speed - How often the interface sends LACP messages. type: str choices: [slow, fast] default: slow more...
- link_up_delay - Number of milliseconds to wait before considering a link is up. type: int default: 50 more...
- member - No description for the parameter type: array
more...
- interface_name - Physical interface name. type: str more...
- min_links - Minimum number of aggregated ports that must be up. type: int default: 1 more...
- min_links_down - Action to take when less than the configured minimum number of links are active. type: str choices: [operational, administrative] default: operational more...
- type - Set type of interface (physical/aggregate). type: str choices: [physical, aggregate, vlan] default: physical more...
- interface - Underlying interface name. type: str more...
- vlan_protocol - Ethernet protocol of VLAN. type: str choices: [8021q, 8021ad] default: 8021q more...
- vlanid - VLAN ID (1 - 4094). type: int default: 0 more...
- lldp - Enable/disable LLDP (Link Layer Discovery Protocol). type: str choices: [disable, enable] default: disable more...
- defaultgw - Enable/disable default gateway. type: str choices: [disable, enable] default: enable more...
- dhcp_client_identifier - DHCP client identifier. type: str more...
- dns_server_override - Enable/disable use DNS acquired by DHCP or PPPoE. type: str choices: [disable, enable] default: enable more...
- mode - Addressing mode (static, DHCP). type: str choices: [static, dhcp] default: static more...
- mtu_override - Enable/disable use MTU acquired by DHCP or PPPoE. type: str choices: [disable, enable] default: enable more...
Notes
Note
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
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Physical interfaces that belong to the aggregate or redundant interface.
fortinet.fortianalyzer.faz_cli_system_interface:
state: present
cli_system_interface:
name: fooaggregate
status: up
type: aggregate
- name: Create faz_cli_system_interface_member.
fortinet.fortianalyzer.faz_cli_system_interface_member:
cli_system_interface_member:
interface_name: port4
interface: fooaggregate
state: present
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Interface configuration.
fortinet.fortianalyzer.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
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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:
- meta - The result of the request. returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list
Status
This module is not guaranteed to have a backwards compatible interface.