drmofu.fortimanager.fmgr_firewall_proxyaddress (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 proxy addresses
      fmgr_fact:
        facts:
            selector: 'firewall_proxyaddress'
            params:
                adom: 'ansible'
                proxy-address: '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: Web proxy address configuration.
      fmgr_firewall_proxyaddress:
         bypass_validation: False
         adom: ansible
         state: present
         firewall_proxyaddress:
            case-sensitivity: disable
            color: 1
            comment: 'ansible-comment'
            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_proxyaddress:
    description: the top level parameters set
    required: false
    suboptions:
      _image-base64:
        description: _Image-Base64.
        type: str
      application:
        description: description
        type: str
      case-sensitivity:
        choices:
        - disable
        - enable
        description: Enable to make the pattern case sensitive.
        type: str
      category:
        description: FortiGuard category ID.
        type: str
      color:
        description: Integer value to determine the color of the icon in the GUI
        type: int
      comment:
        description: Optional comments.
        type: str
      header:
        description: HTTP header name as a regular expression.
        type: str
      header-group:
        description: Header-Group.
        elements: dict
        suboptions:
          case-sensitivity:
            choices:
            - disable
            - enable
            description: Case sensitivity in pattern.
            type: str
          header:
            description: HTTP header regular expression.
            type: str
          header-name:
            description: HTTP header.
            type: str
          id:
            description: ID.
            type: int
        type: list
      header-name:
        description: Name of HTTP header.
        type: str
      host:
        description: Address object for the host.
        type: str
      host-regex:
        description: Host name as a regular expression.
        type: str
      method:
        choices:
        - delete
        - get
        - head
        - options
        - post
        - put
        - trace
        - connect
        description: HTTP request methods to be used.
        elements: str
        type: list
      name:
        description: Address name.
        type: str
      path:
        description: URL path as a regular expression.
        type: str
      query:
        description: Match the query part of the URL as a regular expression.
        type: str
      referrer:
        choices:
        - disable
        - enable
        description: Enable/disable use of referrer field in the HTTP header to match
          the address.
        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: Names of object-tags
        type: str
      type:
        choices:
        - host-regex
        - url
        - category
        - method
        - ua
        - header
        - src-advanced
        - dst-advanced
        - url-list
        - saas
        description: Proxy address type.
        type: str
      ua:
        choices:
        - chrome
        - ms
        - firefox
        - safari
        - other
        - ie
        - edge
        description: Names of browsers to be used as user agent.
        elements: str
        type: list
      ua-max-ver:
        description: Maximum version of the user agent specified in dotted notation.
        type: str
      ua-min-ver:
        description: Minimum version of the user agent specified in dotted notation.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: Enable/disable visibility of the object in the GUI.
        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