drmofu.fortimanager.fmgr_pkg_firewall_centralsnatmap (2.2.2) — module

Configure central SNAT policies.

| "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: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure central SNAT policies.
      fmgr_pkg_firewall_centralsnatmap:
         bypass_validation: False
         adom: ansible
         pkg: ansible # package name
         state: present
         pkg_firewall_centralsnatmap:
            dst-addr: 'ansible-test1'
            nat: enable
            orig-addr: 'ansible-test1'
            policyid: 2
            status: disable
  • 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 central SNAT policies
      fmgr_fact:
        facts:
            selector: 'pkg_firewall_centralsnatmap'
            params:
                adom: 'ansible'
                pkg: 'ansible' # package name
                central-snat-map: 'your_value'

Inputs

    
pkg:
    description: the parameter (pkg) in requested url
    required: true
    type: str

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

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

pkg_firewall_centralsnatmap:
    description: the top level parameters set
    required: false
    suboptions:
      comments:
        description: Comment.
        type: str
      dst-addr:
        description: Destination address name from available addresses.
        type: str
      dst-addr6:
        description: IPv6 Destination address.
        type: str
      dst-port:
        description: Destination port or port range
        type: str
      dstintf:
        description: Destination interface name from available interfaces.
        type: str
      nat:
        choices:
        - disable
        - enable
        description: Enable/disable source NAT.
        type: str
      nat-ippool:
        description: Name of the IP pools to be used to translate addresses from available
          IP Pools.
        type: str
      nat-ippool6:
        description: IPv6 pools to be used for source NAT.
        type: str
      nat-port:
        description: Translated port or port range
        type: str
      nat46:
        choices:
        - disable
        - enable
        description: Enable/disable NAT46.
        type: str
      nat64:
        choices:
        - disable
        - enable
        description: Enable/disable NAT64.
        type: str
      orig-addr:
        description: Original address.
        type: str
      orig-addr6:
        description: IPv6 Original address.
        type: str
      orig-port:
        description: Original TCP port
        type: int
      policyid:
        description: Policy ID.
        type: int
      protocol:
        description: Integer value for the protocol type
        type: int
      srcintf:
        description: Source interface name from available interfaces.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable the active status of this policy.
        type: str
      type:
        choices:
        - ipv4
        - ipv6
        description: IPv4/IPv6 source NAT.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
    type: dict

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