fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy6 (2.4.0) — module

Configure IPv6 interface policies.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

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

  • 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: Configure IPv6 interface policies.
      fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy6:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_interfacepolicy6:
          address-type: ipv6 # <value in [ipv4, ipv6]>
          comments: ansible-comment
          interface: sslvpn_tun_intf
          policyid: 1
          status: enable
  • 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 IPv6 interface policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_interfacepolicy6"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            interface-policy6: "your_value"

Inputs

    
pkg:
    description: The parameter (pkg) in requested url.
    required: true
    type: str

adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

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

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

pkg_firewall_interfacepolicy6:
    description: The top level parameters set.
    required: false
    suboptions:
      address-type:
        choices:
        - ipv4
        - ipv6
        description: Deprecated, please rename it to address_type. Address-Type.
        type: str
      application-list:
        description: Deprecated, please rename it to application_list. Application list
          name.
        type: str
      application-list-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to application_list_status. Enable/disable
          application control.
        type: str
      av-profile:
        description: Deprecated, please rename it to av_profile. Antivirus profile.
        type: str
      av-profile-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to av_profile_status. Enable/disable
          antivirus.
        type: str
      casi-profile:
        description: Deprecated, please rename it to casi_profile. CASI profile name.
        type: str
      casi-profile-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to casi_profile_status. Enable/disable
          CASI.
        type: str
      comments:
        description: Comments.
        type: str
      dlp-profile:
        description: Deprecated, please rename it to dlp_profile. DLP profile name.
        type: str
      dlp-profile-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dlp_profile_status. Enable/disable
          DLP.
        type: str
      dlp-sensor:
        description: Deprecated, please rename it to dlp_sensor. DLP sensor name.
        type: str
      dlp-sensor-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dlp_sensor_status. Enable/disable
          DLP.
        type: str
      dsri:
        choices:
        - disable
        - enable
        description: Enable/disable DSRI.
        type: str
      dstaddr6:
        description: (list or str) IPv6 address object to limit traffic monitoring to
          network traffic sent to the specified address or range.
        type: raw
      emailfilter-profile:
        description: Deprecated, please rename it to emailfilter_profile. Email filter
          profile.
        type: str
      emailfilter-profile-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to emailfilter_profile_status. Enable/disable
          email filter.
        type: str
      interface:
        description: Monitored interface name from available interfaces.
        type: str
      ips-sensor:
        description: Deprecated, please rename it to ips_sensor. IPS sensor name.
        type: str
      ips-sensor-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ips_sensor_status. Enable/disable
          IPS.
        type: str
      label:
        description: Label.
        type: str
      logtraffic:
        choices:
        - disable
        - all
        - utm
        description: Logging type to be used in this policy
        type: str
      policyid:
        description: Policy ID.
        required: true
        type: int
      scan-botnet-connections:
        choices:
        - disable
        - block
        - monitor
        description: Deprecated, please rename it to scan_botnet_connections. Enable/disable
          scanning for connections to Botnet servers.
        type: str
      service6:
        description: (list or str) Service name.
        type: raw
      spamfilter-profile:
        description: Deprecated, please rename it to spamfilter_profile. Antispam profile.
        type: str
      spamfilter-profile-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to spamfilter_profile_status. Enable/disable
          antispam.
        type: str
      srcaddr6:
        description: (list or str) IPv6 address object to limit traffic monitoring to
          network traffic sent from the specified address or range.
        type: raw
      status:
        choices:
        - disable
        - enable
        description: Enable/disable this policy.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      webfilter-profile:
        description: Deprecated, please rename it to webfilter_profile. Web filter profile.
        type: str
      webfilter-profile-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to webfilter_profile_status. Enable/disable
          web filtering.
        type: str
    type: dict

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