drmofu.fortimanager.fmgr_firewall_profilegroup (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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: gathering fortimanager facts
   hosts: fortimanager00
   gather_facts: no
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
   tasks:
    - name: retrieve all the profile groups
      fmgr_fact:
        facts:
            selector: 'firewall_profilegroup'
            params:
                adom: 'ansible'
                profile-group: 'your_value'

Scanned by Steampunk Spotter

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

 - hosts: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure profile groups.
      fmgr_firewall_profilegroup:
         bypass_validation: False
         adom: ansible
         state: present
         firewall_profilegroup:
            application-list: 'default' # need a valid profile name
            name: 'ansible-test'

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
    required: false
    type: list

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

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    type: bool

firewall_profilegroup:
    description: the top level parameters set
    required: false
    suboptions:
      application-list:
        description: Name of an existing Application list.
        type: str
      av-profile:
        description: Name of an existing Antivirus profile.
        type: str
      casi-profile:
        description: CASI profile.
        type: str
      cifs-profile:
        description: Name of an existing CIFS profile.
        type: str
      dlp-profile:
        description: Name of an existing DLP profile.
        type: str
      dlp-sensor:
        description: Name of an existing DLP sensor.
        type: str
      dnsfilter-profile:
        description: Name of an existing DNS filter profile.
        type: str
      emailfilter-profile:
        description: Name of an existing email filter profile.
        type: str
      file-filter-profile:
        description: Name of an existing file-filter profile.
        type: str
      icap-profile:
        description: Name of an existing ICAP profile.
        type: str
      ips-sensor:
        description: Name of an existing IPS sensor.
        type: str
      ips-voip-filter:
        description: Name of an existing VoIP
        type: str
      mms-profile:
        description: Name of an existing MMS profile.
        type: str
      name:
        description: Profile group name.
        type: str
      profile-protocol-options:
        description: Name of an existing Protocol options profile.
        type: str
      sctp-filter-profile:
        description: Name of an existing SCTP filter profile.
        type: str
      spamfilter-profile:
        description: Name of an existing Spam filter profile.
        type: str
      ssh-filter-profile:
        description: Name of an existing SSH filter profile.
        type: str
      ssl-ssh-profile:
        description: Name of an existing SSL SSH profile.
        type: str
      videofilter-profile:
        description: Name of an existing VideoFilter profile.
        type: str
      voip-profile:
        description: Name of an existing VoIP profile.
        type: str
      waf-profile:
        description: Name of an existing Web application firewall profile.
        type: str
      webfilter-profile:
        description: 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.
    required: false
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    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