fmgr_firewall_multicastaddress – Configure multicast addresses.¶

New in version 2.10.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
/pm/config/adom/{adom}/obj/firewall/multicast-address
/pm/config/global/obj/firewall/multicast-address
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.0.0

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.10.0

Parameters ¶

loose_validation - Do parameter validation in a loose way type: bool required: false default: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
url_params - parameters in url path type: dict required: true

adom - the domain prefix type: str choices: none, global, custom dom

parameters for method: [add, set, update] - Configure multicast addresses.

data - No description for the parameter type: array
- associated-interface - Interface associated with the address object. type: str
- color - Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1). type: int
- comment - Comment. type: str
- end-ip - Final IPv4 address (inclusive) in the range for the address. type: str
- name - Multicast address name. type: str
- start-ip - First IPv4 address (inclusive) in the range for the address. type: str
- subnet - Broadcast address and subnet. type: str
- tagging - No description for the parameter type: array
  - category - Tag category. type: str
  - name - Tagging entry name. type: str
  - tags - No description for the parameter type: array
    - {no-name} - No description for the parameter type: str
- type - Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. type: str choices: [multicastrange, broadcastmask]
- visibility - Enable/disable visibility of the multicast address on the GUI. type: str choices: [disable, enable]

parameters for method: [get] - Configure multicast addresses.

attr - The name of the attribute to retrieve its datasource. type: str
fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str choices: [associated-interface, color, comment, end-ip, name, start-ip, subnet, type, visibility]
filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
get used - No description for the parameter type: int
loadsub - Enable or disable the return of any sub-objects. type: int
option - Set fetch option for the request. type: str choices: [count, object member, datasrc, get reserved, syntax]
range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]

Notes ¶

Note

The module may supports multiple method, every method has different parameters definition
One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
The module may include domain dependent urls, the domain can be specified in url_params as adom
To run in workspace mode, the paremeter workspace_locking_adom must be included in the task

Examples ¶

- 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: REQUESTING /PM/CONFIG/OBJ/FIREWALL/MULTICAST-ADDRESS
     fmgr_firewall_multicastaddress:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              data:
                -
                    associated-interface: <value of string>
                    color: <value of integer>
                    comment: <value of string>
                    end-ip: <value of string>
                    name: <value of string>
                    start-ip: <value of string>
                    subnet: <value of string>
                    tagging:
                      -
                          category: <value of string>
                          name: <value of string>
                          tags:
                            - <value of string>
                    type: <value in [multicastrange, broadcastmask]>
                    visibility: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/MULTICAST-ADDRESS
     fmgr_firewall_multicastaddress:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
        params:
           -
              attr: <value of string>
              fields:
                -
                   - <value in [associated-interface, color, comment, ...]>
              filter:
                - <value of string>
              get used: <value of integer>
              loadsub: <value of integer>
              option: <value in [count, object member, datasrc, ...]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

Return Values ¶

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

return values for method: [add, set, update]

status - No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/firewall/multicast-address

return values for method: [get]

data - No description for the parameter type: array
- associated-interface - Interface associated with the address object. type: str
- color - Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1). type: int
- comment - Comment. type: str
- end-ip - Final IPv4 address (inclusive) in the range for the address. type: str
- name - Multicast address name. type: str
- start-ip - First IPv4 address (inclusive) in the range for the address. type: str
- subnet - Broadcast address and subnet. type: str
- tagging - No description for the parameter type: array
  - category - Tag category. type: str
  - name - Tagging entry name. type: str
  - tags - No description for the parameter type: array
    - {no-name} - No description for the parameter type: str
- type - Type of address object: multicast IP address range or broadcast IP/mask to be treated as a multicast address. type: str
- visibility - Enable/disable visibility of the multicast address on the GUI. type: str
status - No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/firewall/multicast-address

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Frank Shen (@fshen01)
Link Zheng (@zhengl)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.