:source: fmgd_firewall_address.py :orphan: .. _fmgd_firewall_address: fmgd_firewall_address -- Configure IPv4 addresses. ++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiManager device. - Examples include all parameters and values need to be adjusted to data sources before usage. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters ---------- .. raw:: html Notes ----- .. note:: - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded Examples -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure IPv4 addresses. fortinet.fmgdevice.fmgd_firewall_address: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # firewall_address: name: "your value" # Required variable, string # _image_base64: # allow_routing: # associated_interface: # cache_ttl: # clearpass_spt: # color: # comment: # country: # dirty: # dynamic_mapping: # - _image_base64: # _scope: # - name: # vdom: # allow_routing: # associated_interface: # cache_ttl: # clearpass_spt: # color: # comment: # country: # dirty: # end_ip: # end_mac: # epg_name: # fabric_object: # filter: # fqdn: # fsso_group: # global_object: # hw_model: # hw_vendor: # interface: # macaddr: # node_ip_only: # obj_id: # obj_tag: # obj_type: # organization: # os: # pattern_end: # pattern_start: # policy_group: # route_tag: # sdn: # sdn_addr_type: # sdn_tag: # start_ip: # start_mac: # sub_type: # subnet: # subnet_name: # sw_version: # tag_detection_level: # tag_type: # tags: # tenant: # type: # url: # uuid: # visibility: # wildcard: # wildcard_fqdn: # agent_id: # sso_attribute_value: # tag_uuid: # passive_fqdn_learning: # end_ip: # epg_name: # fabric_object: # filter: # fqdn: # fsso_group: # interface: # list: # - ip: # net_id: # obj_id: # node_ip_only: # obj_id: # obj_tag: # obj_type: # organization: # pattern_end: # pattern_start: # policy_group: # sdn: # sdn_addr_type: # sdn_tag: # start_ip: # sub_type: # subnet: # subnet_name: # tag_detection_level: # tag_type: # tagging: # - category: # name: # tags: # tenant: # type: # uuid: # wildcard: # wildcard_fqdn: # hw_model: # route_tag: # sw_version: # macaddr: # hw_vendor: # os: # global_object: # start_mac: # end_mac: # visibility: # tags: # tag_uuid: # sso_attribute_value: # agent_id: # passive_fqdn_learning: 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: .. raw:: html
  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)