fadcos_interface – interface configuration in Fortinet’s FortiADC¶
New in version 1.0.0.
FortiADC Version Compatibility¶
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.1.0 |
v7.1.4 |
v7.2.2 |
v7.4.0 |
|
| fortiadc_interface | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- action - Type of action to perform on the object. type: str required: true
- name - interface nametype: str required: true
- mode - static,pppoe or dhcptype: str required: false default: static
- status - interface status up/downtype: str required: false default: up
- IPandMask - ip address of interfacetype: str required: true (if mode is static and IPv6andMask not set)
- IPv6andMask - ipv6 address of interfacetype: str required: true (if mode is static and IPandMask not set)
- allowaccess - Allow access with the interfacei(https, ping, ssh, snmp, http, telnet)type: str required: false
- intf_type - interface type(physical/vlan/aggregate/loopback/soft-switch/vxlan/nvgre/vdom-link)type: str required: true
- vlanid - Vlan IDtype: str required: true (if type is vlan)
- vdom - vdom nametype: str required: true (if VDOM is enabled)
- interface - physical interface nametype: str required: true (if intf_type is vlan)
- mtu - maximum transportation unit 68-9000type: str required: false default: 1500
- aggregate_algorithm - aggregate interface slave selection algorithm layer2/layer2-3/layer3-4type: str required: false default: layer2-3
- aggregate_mode - aggregate mode (balance-rr/balance-xor/broadcast/802.3ad/balance-tlb/balance-alb)type: str required: false default: 802.3ad
- default_gw - default gatewaytype: str required: false
- dhcp_gw_override - enable/disable to override gatewaytype: str required: false default: disable
- dhcp_gw_distance - distance for dhcp_gatewaytype: str required: false default: 10
- disc_retry_timeout - pppoe discovery retry timeouttype: str required: false default: 5
- pppoe_username - pppoe account user nametype: str required: false
- pppoe_passwd - pppoe account passwordtype: str required: false default:
- floating - enable/disable to set floating iptype: str required: false default: disable
- floating_ip - floating ip address of interfacetype: str required: false default: 0.0.0.0
- redundant_member - redundant/aggregate interface slavestype: str required: false
- traffic_group - traffic group nametype: str required: false
Examples¶
- name:
hosts: all
connection: httpapi
gather_facts: false
tasks:
- name: Manage interface
fadcos_interface:
action: get
name: testport
mode: static
intf_type: vlan
interface: port5
vlanid: 100
IPandMask: 123.23.3.12/24
allowaccess:
- snmp
- http
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:
- 200 - OK: Request returns successful.
- 400 - Bad Request: Request cannot be processed by the API.
- 401 - Not Authorized: Request without successful login session.
- 403 - Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
- 404 - Resource Not Found: Unable to find the specified resource.
- 405 - Method Not Allowed: Specified HTTP method is not allowed for this resource.
- 413 - Request Entity Too Large: Request cannot be processed due to large entity.
- 424 - Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, or invalid attribute value.
- 429 - Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
- 500 - Internal Server Error: Internal error when processing the request.
For errorcode please check FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/