fortinet.fortimanager.fmgr_firewall_profilegroup (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: Configure profile groups.
      fortinet.fortimanager.fmgr_firewall_profilegroup:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_profilegroup:
          application-list: "default" # need a valid profile name
          name: "ansible-test"

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 profile groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_profilegroup"
          params:
            adom: "ansible"
            profile-group: "your_value"

Inputs

    
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

firewall_profilegroup:
    description: The top level parameters set.
    required: false
    suboptions:
      application-list:
        description: Deprecated, please rename it to application_list. Name of an existing
          Application list.
        type: str
      av-profile:
        description: Deprecated, please rename it to av_profile. Name of an existing Antivirus
          profile.
        type: str
      casb-profile:
        description: Deprecated, please rename it to casb_profile. Name of an existing
          CASB profile.
        type: str
      casi-profile:
        description: Deprecated, please rename it to casi_profile. CASI profile.
        type: str
      cifs-profile:
        description: Deprecated, please rename it to cifs_profile. Name of an existing
          CIFS profile.
        type: str
      diameter-filter-profile:
        description: Deprecated, please rename it to diameter_filter_profile. Name of
          an existing Diameter filter profile.
        type: str
      dlp-profile:
        description: Deprecated, please rename it to dlp_profile. Name of an existing
          DLP profile.
        type: str
      dlp-sensor:
        description: Deprecated, please rename it to dlp_sensor. Name of an existing DLP
          sensor.
        type: str
      dnsfilter-profile:
        description: Deprecated, please rename it to dnsfilter_profile. Name of an existing
          DNS filter profile.
        type: str
      emailfilter-profile:
        description: Deprecated, please rename it to emailfilter_profile. Name of an existing
          email filter profile.
        type: str
      file-filter-profile:
        description: Deprecated, please rename it to file_filter_profile. Name of an existing
          file-filter profile.
        type: str
      icap-profile:
        description: Deprecated, please rename it to icap_profile. Name of an existing
          ICAP profile.
        type: str
      ips-sensor:
        description: Deprecated, please rename it to ips_sensor. Name of an existing IPS
          sensor.
        type: str
      ips-voip-filter:
        description: Deprecated, please rename it to ips_voip_filter. Name of an existing
          VoIP
        type: str
      mms-profile:
        description: Deprecated, please rename it to mms_profile. Name of an existing
          MMS profile.
        type: str
      name:
        description: Profile group name.
        required: true
        type: str
      profile-protocol-options:
        description: Deprecated, please rename it to profile_protocol_options. Name of
          an existing Protocol options profile.
        type: str
      sctp-filter-profile:
        description: Deprecated, please rename it to sctp_filter_profile. Name of an existing
          SCTP filter profile.
        type: str
      spamfilter-profile:
        description: Deprecated, please rename it to spamfilter_profile. Name of an existing
          Spam filter profile.
        type: str
      ssh-filter-profile:
        description: Deprecated, please rename it to ssh_filter_profile. Name of an existing
          SSH filter profile.
        type: str
      ssl-ssh-profile:
        description: Deprecated, please rename it to ssl_ssh_profile. Name of an existing
          SSL SSH profile.
        type: str
      videofilter-profile:
        description: Deprecated, please rename it to videofilter_profile. Name of an existing
          VideoFilter profile.
        type: str
      virtual-patch-profile:
        description: Deprecated, please rename it to virtual_patch_profile. Name of an
          existing virtual-patch profile.
        type: str
      voip-profile:
        description: Deprecated, please rename it to voip_profile. Name of an existing
          VoIP profile.
        type: str
      waf-profile:
        description: Deprecated, please rename it to waf_profile. Name of an existing
          Web application firewall profile.
        type: str
      webfilter-profile:
        description: Deprecated, please rename it to webfilter_profile. Name of an existing
          Web filter profile.
        type: str
    type: dict

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