fortinet.fortimanager.fmgr_system_interface (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Interface configuration.
      fortinet.fortimanager.fmgr_system_interface:
        bypass_validation: false
        state: present
        system_interface:
          allowaccess:
            - ping
          ip: "222.222.22.2/24"
          mtu: 1500
          name: port4
          serviceaccess:
            - fgtupdates
          speed: auto # <value in [auto, 10full, 10half, ...]>
          status: up

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the interfaces
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_interface"
          params:
            interface: "your_value"

Inputs

    
state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

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
        - https-logging
        - soc-fabric
        - fabric
        description:
        - Allow management access to interface.
        - ping - PING access.
        - https - HTTPS access.
        - ssh - SSH access.
        - snmp - SNMP access.
        - http - HTTP access.
        - webservice - Web service access.
        - https-logging - Logging over HTTPS access.
        elements: str
        type: list
      defaultgw:
        choices:
        - disable
        - enable
        description:
        - Enable/disable default gateway.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      description:
        description: Description.
        type: str
      dhcp-client-identifier:
        description: Deprecated, please rename it to dhcp_client_identifier. DHCP client
          identifier.
        type: str
      dns-server-override:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to dns_server_override.
        - Enable/disable use DNS acquired by DHCP or PPPoE.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      interface:
        description: Underlying interface name.
        type: str
      ip:
        description: IP address of interface.
        type: str
      ipv6:
        description: No description.
        suboptions:
          ip6-address:
            description: Deprecated, please rename it to ip6_address. IPv6 address/prefix
              of interface.
            type: str
          ip6-allowaccess:
            choices:
            - ping
            - https
            - ssh
            - snmp
            - http
            - webservice
            - https-logging
            - fabric
            description:
            - Deprecated, please rename it to ip6_allowaccess.
            - Allow management access to interface.
            - ping - PING access.
            - https - HTTPS access.
            - ssh - SSH access.
            - snmp - SNMP access.
            - http - HTTP access.
            - webservice - Web service access.
            - https-logging - Logging over HTTPS access.
            elements: str
            type: list
          ip6-autoconf:
            choices:
            - disable
            - enable
            description:
            - Deprecated, please rename it to ip6_autoconf.
            - Enable/disable address auto config
            - disable - Disable setting.
            - enable - Enable setting.
            type: str
        type: dict
      lacp-mode:
        choices:
        - active
        description:
        - Deprecated, please rename it to lacp_mode.
        - LACP mode.
        - active - Actively use LACP to negotiate 802.
        type: str
      lacp-speed:
        choices:
        - slow
        - fast
        description:
        - Deprecated, please rename it to lacp_speed.
        - 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: Deprecated, please rename it to link_up_delay. Number of milliseconds
          to wait before considering a link is up.
        type: int
      lldp:
        choices:
        - disable
        - enable
        description:
        - Enable/disable LLDP
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      member:
        description: No description.
        elements: dict
        suboptions:
          interface-name:
            description: Deprecated, please rename it to interface_name. Physical interface
              name.
            type: str
        type: list
      min-links:
        description: Deprecated, please rename it to min_links. Minimum number of aggregated
          ports that must be up.
        type: int
      min-links-down:
        choices:
        - operational
        - administrative
        description:
        - Deprecated, please rename it to min_links_down.
        - 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
      mode:
        choices:
        - static
        - dhcp
        description:
        - Addressing mode
        - static - Static setting.
        - dhcp - External DHCP client mode.
        type: str
      mtu:
        description: Maximum transportation unit
        type: int
      mtu-override:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to mtu_override.
        - Enable/disable use MTU acquired by DHCP or PPPoE.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      name:
        description: Interface name.
        required: true
        type: str
      rating-service-ip:
        description: Deprecated, please rename it to rating_service_ip. IP address for
          fgt rating service, must be same subnet with interface ip.
        type: str
      serviceaccess:
        choices:
        - fgtupdates
        - fclupdates
        - webfilter-antispam
        description:
        - Allow service access to interface.
        - fgtupdates - FortiGate updates access.
        - fclupdates - FortiClient updates access.
        - webfilter-antispam - Web filtering and antispam access.
        elements: str
        type: list
      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:
        - vlan
        - physical
        - aggregate
        description:
        - Interface type.
        - vlan - VLAN interface.
        - physical - Physical interface.
        - aggregate - Aggregate interface.
        type: str
      update-service-ip:
        description: Deprecated, please rename it to update_service_ip. IP address for
          fgt/fct update service, must be same subnet with interfa...
        type: str
      vlan-protocol:
        choices:
        - 8021q
        - 8021ad
        description:
        - Deprecated, please rename it to vlan_protocol.
        - Ethernet protocol of VLAN.
        - 8021q - IEEE 802.
        - 8021ad - IEEE 802.
        type: str
      vlanid:
        description: VLAN ID
        type: int
    type: dict

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

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 FortiManager version.
  returned: complex
  type: list