drmofu.fortimanager.fmgr_firewall_address6_dynamicmapping (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 dynamic mappings of IPv6 address
      fmgr_fact:
        facts:
            selector: 'firewall_address6_dynamicmapping'
            params:
                adom: 'ansible'
                address6: 'ansible-test' # name
                dynamic_mapping: '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 dynamic mappings of IPv6 address
      fmgr_firewall_address6_dynamicmapping:
         bypass_validation: False
         adom: ansible
         address6: 'ansible-test' # name
         state: present
         firewall_address6_dynamicmapping:
            _scope:
              -
                  name: FGT_AWS # need a valid device name
                  vdom: root # need a valid vdom name under the device
            cache-ttl: 0
            color: 22
            comment: 'ansible-test-comment'
            end-ip: '::100'
            host: '::'
            host-type: any #<value in [any, specific]>
            ip6: '::/128'
            start-ip: '::'
            type: iprange #<value in [ipprefix, iprange, nsx, ...]>
            visibility: enable

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

address6:
    description: the parameter (address6) 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

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

firewall_address6_dynamicmapping:
    description: the top level parameters set
    required: false
    suboptions:
      _image-base64:
        description: no description
        type: str
      _scope:
        description: description
        elements: dict
        suboptions:
          name:
            description: no description
            type: str
          vdom:
            description: no description
            type: str
        type: list
      cache-ttl:
        description: no description
        type: int
      color:
        description: no description
        type: int
      comment:
        description: no description
        type: str
      country:
        description: no description
        type: str
      end-ip:
        description: no description
        type: str
      end-mac:
        description: no description
        type: str
      epg-name:
        description: Endpoint group name.
        type: str
      fabric-object:
        choices:
        - disable
        - enable
        description: Security Fabric global object setting.
        type: str
      fqdn:
        description: no description
        type: str
      global-object:
        description: no description
        type: int
      host:
        description: no description
        type: str
      host-type:
        choices:
        - any
        - specific
        description: no description
        type: str
      ip6:
        description: no description
        type: str
      macaddr:
        description: description
        type: str
      obj-id:
        description: no description
        type: str
      route-tag:
        description: route-tag address.
        type: int
      sdn:
        choices:
        - nsx
        description: no description
        type: str
      sdn-tag:
        description: SDN Tag.
        type: str
      start-ip:
        description: no description
        type: str
      start-mac:
        description: no description
        type: str
      subnet-segment:
        description: description
        elements: dict
        suboptions:
          name:
            description: no description
            type: str
          type:
            choices:
            - any
            - specific
            description: no description
            type: str
          value:
            description: no description
            type: str
        type: list
      tags:
        description: no description
        type: str
      template:
        description: no description
        type: str
      tenant:
        description: Tenant.
        type: str
      type:
        choices:
        - ipprefix
        - iprange
        - nsx
        - dynamic
        - fqdn
        - template
        - mac
        - geography
        - route-tag
        description: no description
        type: str
      uuid:
        description: no description
        type: str
      visibility:
        choices:
        - disable
        - enable
        description: no description
        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