drmofu.fortimanager.fmgr_firewall_service_custom (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.

 - 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 custom services.
      fmgr_firewall_service_custom:
         bypass_validation: False
         adom: ansible
         state: present
         firewall_service_custom:
            app-service-type: disable #<value in [disable, app-id, app-category]>
            color: 1
            comment: 'comment'
            helper: auto #<value in [disable, auto, ftp, ...]>
            name: 'ansible-test'
            protocol: ALL #<value in [ICMP, IP, TCP/UDP/SCTP, ...]>
            proxy: enable #<value in [disable, enable]>
            visibility: enable #<value in [disable, enable]>

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 custom services
      fmgr_fact:
        facts:
            selector: 'firewall_service_custom'
            params:
                adom: 'ansible'
                custom: '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
    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

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

firewall_service_custom:
    description: the top level parameters set
    required: false
    suboptions:
      app-category:
        description: Application category ID.
        type: int
      app-service-type:
        choices:
        - disable
        - app-id
        - app-category
        description: Application service type.
        type: str
      application:
        description: Application ID.
        type: int
      category:
        description: Service category.
        type: str
      check-reset-range:
        choices:
        - disable
        - default
        - strict
        description: Configure the type of ICMP error message verification.
        type: str
      color:
        description: Color of icon on the GUI.
        type: int
      comment:
        description: no description
        type: str
      explicit-proxy:
        choices:
        - disable
        - enable
        description: Enable/disable explicit web proxy service.
        type: str
      fabric-object:
        choices:
        - disable
        - enable
        description: Security Fabric global object setting.
        type: str
      fqdn:
        description: Fully qualified domain name.
        type: str
      global-object:
        description: Global Object.
        type: int
      helper:
        choices:
        - disable
        - auto
        - ftp
        - tftp
        - ras
        - h323
        - tns
        - mms
        - sip
        - pptp
        - rtsp
        - dns-udp
        - dns-tcp
        - pmap
        - rsh
        - dcerpc
        - mgcp
        - gtp-c
        - gtp-u
        - gtp-b
        - pfcp
        description: Helper name.
        type: str
      icmpcode:
        description: ICMP code.
        type: int
      icmptype:
        description: ICMP type.
        type: int
      iprange:
        description: Start and end of the IP range associated with service.
        type: str
      name:
        description: Custom service name.
        type: str
      protocol:
        choices:
        - ICMP
        - IP
        - TCP/UDP/SCTP
        - ICMP6
        - HTTP
        - FTP
        - CONNECT
        - SOCKS
        - ALL
        - SOCKS-TCP
        - SOCKS-UDP
        description: Protocol type based on IANA numbers.
        type: str
      protocol-number:
        description: IP protocol number.
        type: int
      proxy:
        choices:
        - disable
        - enable
        description: Enable/disable web proxy service.
        type: str
      sctp-portrange:
        description: Multiple SCTP port ranges.
        type: str
      session-ttl:
        description: Session TTL
        type: int
      tcp-halfclose-timer:
        description: Wait time to close a TCP session waiting for an unanswered FIN packet
        type: int
      tcp-halfopen-timer:
        description: Wait time to close a TCP session waiting for an unanswered open session
          packet
        type: int
      tcp-portrange:
        description: Multiple TCP port ranges.
        type: str
      tcp-rst-timer:
        description: Set the length of the TCP CLOSE state in seconds
        type: int
      tcp-timewait-timer:
        description: Set the length of the TCP TIME-WAIT state in seconds
        type: int
      udp-idle-timer:
        description: UDP half close timeout
        type: int
      udp-portrange:
        description: Multiple UDP port ranges.
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: Enable/disable the visibility of the service on the GUI.
        type: str
    type: dict

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