drmofu.fortimanager.fmgr_firewall_internetservice (2.2.2) — module

Show Internet Service application.

| "added in version" 2.0.0 of drmofu.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 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

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Show Internet Service application.
      fmgr_firewall_internetservice:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         adom: <your own value>
         firewall_internetservice:
            database: <value in [isdb, irdb]>
            direction: <value in [src, dst, both]>
            entry:
              -
                  id: <value of integer>
                  ip-number: <value of integer>
                  ip-range-number: <value of integer>
                  port: <value of integer>
                  protocol: <value of integer>
            icon-id: <value of integer>
            id: <value of integer>
            name: <value of string>
            offset: <value of integer>
            reputation: <value of integer>
            sld-id: <value of integer>
            extra-ip-range-number: <value of integer>
            ip-number: <value of integer>
            ip-range-number: <value of integer>
            jitter-threshold: <value of integer>
            latency-threshold: <value of integer>
            obsolete: <value of integer>
            packetloss-threshold: <value of integer>
            singularity: <value of integer>
            city: <value of integer>
            country: <value of integer>
            region: <value of integer>
            city6: <value of integer>
            country6: <value of integer>
            extra-ip6-range-number: <value of integer>
            ip6-range-number: <value of integer>
            region6: <value of integer>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    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

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

firewall_internetservice:
    description: the top level parameters set
    required: false
    suboptions:
      city:
        description: City sequence number list.
        type: int
      city6:
        description: description
        type: int
      country:
        description: Country sequence number list.
        type: int
      country6:
        description: description
        type: int
      database:
        choices:
        - isdb
        - irdb
        description: Database.
        type: str
      direction:
        choices:
        - src
        - dst
        - both
        description: Direction.
        type: str
      entry:
        description: description
        elements: dict
        suboptions:
          id:
            description: Entry ID.
            type: int
          ip-number:
            description: Total number of IP addresses.
            type: int
          ip-range-number:
            description: Total number of IP ranges.
            type: int
          port:
            description: description
            type: int
          protocol:
            description: Integer value for the protocol type as defined by IANA
            type: int
        type: list
      extra-ip-range-number:
        description: Extra-Ip-Range-Number.
        type: int
      extra-ip6-range-number:
        description: no description
        type: int
      icon-id:
        description: Icon-Id.
        type: int
      id:
        description: Id.
        type: int
      ip-number:
        description: Ip-Number.
        type: int
      ip-range-number:
        description: Ip-Range-Number.
        type: int
      ip6-range-number:
        description: no description
        type: int
      jitter-threshold:
        description: Jitter-Threshold.
        type: int
      latency-threshold:
        description: Latency-Threshold.
        type: int
      name:
        description: Name.
        type: str
      obsolete:
        description: Obsolete.
        type: int
      offset:
        description: no description
        type: int
      packetloss-threshold:
        description: Packetloss-Threshold.
        type: int
      region:
        description: Region sequence number list.
        type: int
      region6:
        description: description
        type: int
      reputation:
        description: Reputation.
        type: int
      singularity:
        description: Singularity.
        type: int
      sld-id:
        description: Sld-Id.
        type: int
    type: dict

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