- source
fmgr_firewall_gtp_ievalidation.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- gtp - The parameter in requested url type: str required: true
- firewall_gtp_ievalidation - IE validation. type: dict
- apn_restriction (Alias name: apn-restriction) Validate apn restriction. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- charging_ID (Alias name: charging-ID) Validate charging id. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- charging_gateway_addr (Alias name: charging-gateway-addr) Validate charging gateway address. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- end_user_addr (Alias name: end-user-addr) Validate end user address. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- gsn_addr (Alias name: gsn-addr) Validate gsn address. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- imei Validate imei(sv). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- imsi Validate imsi. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- mm_context (Alias name: mm-context) Validate mm context. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ms_tzone (Alias name: ms-tzone) Validate ms time zone. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ms_validated (Alias name: ms-validated) Validate ms validated. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- msisdn Validate msisdn. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- nsapi Validate nsapi. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- pdp_context (Alias name: pdp-context) Validate pdp context. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- qos_profile (Alias name: qos-profile) Validate quality of service(qos) profile. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- rai Validate rai. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- rat_type (Alias name: rat-type) Validate rat type. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- reordering_required (Alias name: reordering-required) Validate re-ordering required. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- selection_mode (Alias name: selection-mode) Validate selection mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- uli Validate user location information. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: IE validation.
fortinet.fortimanager.fmgr_firewall_gtp_ievalidation:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
gtp: <your own value>
firewall_gtp_ievalidation:
apn_restriction: <value in [disable, enable]>
charging_ID: <value in [disable, enable]>
charging_gateway_addr: <value in [disable, enable]>
end_user_addr: <value in [disable, enable]>
gsn_addr: <value in [disable, enable]>
imei: <value in [disable, enable]>
imsi: <value in [disable, enable]>
mm_context: <value in [disable, enable]>
ms_tzone: <value in [disable, enable]>
ms_validated: <value in [disable, enable]>
msisdn: <value in [disable, enable]>
nsapi: <value in [disable, enable]>
pdp_context: <value in [disable, enable]>
qos_profile: <value in [disable, enable]>
rai: <value in [disable, enable]>
rat_type: <value in [disable, enable]>
reordering_required: <value in [disable, enable]>
selection_mode: <value in [disable, enable]>
uli: <value in [disable, enable]>
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:
- 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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)