fmgr_firewall_multicastaddress_obj – Configure multicast addresses.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [clone, delete, get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/obj/firewall/multicast-address/{multicast-address}
- /pm/config/global/obj/firewall/multicast-address/{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
- multicast-address - the object name type: str
- parameters for method: [clone, set, update] - Configure multicast addresses.
- data - No description for the parameter type: dict
- 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: [delete] - Configure multicast addresses.
- parameters for method: [get] - Configure multicast addresses.
- option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]
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/{MULTICAST-ADDRESS}
fmgr_firewall_multicastaddress_obj:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [clone, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
multicast-address: <value of string>
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/{MULTICAST-ADDRESS}
fmgr_firewall_multicastaddress_obj:
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]>
multicast-address: <value of string>
params:
-
option: <value in [object member, chksum, datasrc]>
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: [clone, delete, 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/{multicast-address}
- return values for method: [get]
- data
- No description for the parameter type: dict
- 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/{multicast-address}