drmofu.fortimanager.fmgr_firewall_addrgrp (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 IPv4 address groups
      fmgr_fact:
        facts:
            selector: 'firewall_addrgrp'
            params:
                adom: 'ansible'
                addrgrp: '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 IPv4 address groups.
      fmgr_firewall_addrgrp:
         bypass_validation: False
         adom: ansible
         state: present
         firewall_addrgrp:
            allow-routing: disable
            color: 0
            member: 'ansible-test1' # IPv4 address name
            name: 'ansible-addrgrp4' # could not the same with other group, adress name, including IPv6 group and address
            visibility: disable

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

firewall_addrgrp:
    description: the top level parameters set
    required: false
    suboptions:
      _image-base64:
        description: _Image-Base64.
        type: str
      allow-routing:
        choices:
        - disable
        - enable
        description: Enable/disable use of this group in the static route configuration.
        type: str
      category:
        choices:
        - default
        - ztna-ems-tag
        - ztna-geo-tag
        description: Address group category.
        type: str
      color:
        description: Color of icon on the GUI.
        type: int
      comment:
        description: no description
        type: str
      dynamic_mapping:
        description: Dynamic_Mapping.
        elements: dict
        suboptions:
          _image-base64:
            description: _Image-Base64.
            type: str
          _scope:
            description: _Scope.
            elements: dict
            suboptions:
              name:
                description: Name.
                type: str
              vdom:
                description: Vdom.
                type: str
            type: list
          allow-routing:
            choices:
            - disable
            - enable
            description: Enable/disable use of this group in the static route configuration.
            type: str
          category:
            choices:
            - default
            - ztna-ems-tag
            - ztna-geo-tag
            description: Address group category.
            type: str
          color:
            description: Color of icon on the GUI.
            type: int
          comment:
            description: no description
            type: str
          exclude:
            choices:
            - disable
            - enable
            description: Enable/disable address exclusion.
            type: str
          exclude-member:
            description: Address exclusion member.
            type: str
          fabric-object:
            choices:
            - disable
            - enable
            description: Security Fabric global object setting.
            type: str
          global-object:
            description: Global-Object.
            type: int
          member:
            description: Address objects contained within the group.
            elements: str
            type: list
          tags:
            description: Tags.
            type: str
          type:
            choices:
            - default
            - array
            - folder
            description: Type.
            type: str
          uuid:
            description: Universally Unique Identifier
            type: str
          visibility:
            choices:
            - disable
            - enable
            description: Enable/disable address visibility in the GUI.
            type: str
        type: list
      exclude:
        choices:
        - disable
        - enable
        description: Enable/disable address exclusion.
        type: str
      exclude-member:
        description: Address exclusion member.
        type: str
      fabric-object:
        choices:
        - disable
        - enable
        description: Security Fabric global object setting.
        type: str
      global-object:
        description: Global Object.
        type: int
      member:
        description: Address objects contained within the group.
        elements: str
        type: list
      name:
        description: Address group name.
        type: str
      tagging:
        description: Tagging.
        elements: dict
        suboptions:
          category:
            description: Tag category.
            type: str
          name:
            description: Tagging entry name.
            type: str
          tags:
            description: Tags.
            type: str
        type: list
      tags:
        description: Name
        type: str
      type:
        choices:
        - default
        - array
        - folder
        description: Address group type.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: Enable/disable address visibility in the GUI.
        type: str
    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.
    required: false
    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.
    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