fortinet.fortimanager.fmgr_user_device_dynamicmapping (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dynamic mappings
      fortinet.fortimanager.fmgr_user_device_dynamicmapping:
        bypass_validation: false
        adom: ansible
        device: ansible-test-device # alias
        state: present
        user_device_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          category: none # <value in [none, android-device, blackberry-device, ...]>
          comment: ansible-comment
          mac: "00:11:22:33:44:55"
          type: iphone # <value in [ipad, iphone, gaming-console, ...]>

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the dynamic mappings
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_device_dynamicmapping"
          params:
            adom: "ansible"
            device: "ansible-test-device" # alias
            dynamic_mapping: "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

device:
    description: The parameter (device) 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
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    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.
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

user_device_dynamicmapping:
    description: The top level parameters set.
    required: false
    suboptions:
      _scope:
        description: No description.
        elements: dict
        suboptions:
          name:
            description: No description.
            type: str
          vdom:
            description: No description.
            type: str
        type: list
      avatar:
        description: No description.
        type: str
      category:
        choices:
        - none
        - android-device
        - blackberry-device
        - fortinet-device
        - ios-device
        - windows-device
        - amazon-device
        description: No description.
        type: str
      comment:
        description: No description.
        type: str
      family:
        description: No description.
        type: str
      hardware-vendor:
        description: Deprecated, please rename it to hardware_vendor.
        type: str
      hardware-version:
        description: Deprecated, please rename it to hardware_version.
        type: str
      mac:
        description: No description.
        type: str
      master-device:
        description: Deprecated, please rename it to master_device.
        type: str
      os:
        description: No description.
        type: str
      software-version:
        description: Deprecated, please rename it to software_version.
        type: str
      tags:
        description: (list or str) No description.
        type: raw
      type:
        choices:
        - ipad
        - iphone
        - gaming-console
        - blackberry-phone
        - blackberry-playbook
        - linux-pc
        - mac
        - windows-pc
        - android-phone
        - android-tablet
        - media-streaming
        - windows-phone
        - fortinet-device
        - ip-phone
        - router-nat-device
        - other-network-device
        - windows-tablet
        - printer
        - forticam
        - fortifone
        - unknown
        description: No description.
        type: str
      user:
        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