Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
duality-group / ansible python
Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
from __future__ import absolute_import, division, print_function
# Copyright 2019-2021 Fortinet, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
__metaclass__ = type
ANSIBLE_METADATA = {'status': ['preview'],
'supported_by': 'community',
'metadata_version': '1.1'}
DOCUMENTATION = '''
---
module: fmgr_wanopt_profile
short_description: Configure WAN optimization profiles.
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.
version_added: "2.10"
author:
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
notes:
- 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
options:
enable_log:
description: Enable/Disable logging for task
required: false
type: bool
default: false
proposed_method:
description: The overridden method for the underlying Json RPC request
required: false
type: str
choices:
- update
- set
- add
bypass_validation:
description: only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
required: false
type: bool
default: false
workspace_locking_adom:
description: the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
required: false
type: str
workspace_locking_timeout:
description: the maximum time in seconds to wait for other user to release the workspace lock
required: false
type: int
default: 300
state:
description: the directive to create, update or delete an object
type: str
required: true
choices:
- present
- absent
rc_succeeded:
description: the rc codes list with which the conditions to succeed will be overriden
type: list
required: false
rc_failed:
description: the rc codes list with which the conditions to fail will be overriden
type: list
required: false
adom:
description: the parameter (adom) in requested url
type: str
required: true
wanopt_profile:
description: the top level parameters set
required: false
type: dict
suboptions:
auth-group:
type: str
description: 'Optionally add an authentication group to restrict access to the WAN Optimization tunnel to peers in the authentication group.'
comments:
type: str
description: 'Comment.'
name:
type: str
description: 'Profile name.'
transparent:
type: str
description: 'Enable/disable transparent mode.'
choices:
- 'disable'
- 'enable'
cifs:
description: no description
type: dict
required: false
suboptions:
byte-caching:
type: str
description: 'Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...'
choices:
- 'disable'
- 'enable'
log-traffic:
type: str
description: 'Enable/disable logging.'
choices:
- 'disable'
- 'enable'
prefer-chunking:
type: str
description: 'Select dynamic or fixed-size data chunking for WAN Optimization.'
choices:
- 'dynamic'
- 'fix'
protocol-opt:
type: str
description: 'Select Protocol specific optimitation or generic TCP optimization.'
choices:
- 'protocol'
- 'tcp'
secure-tunnel:
type: str
description: 'Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).'
choices:
- 'disable'
- 'enable'
status:
type: str
description: 'Enable/disable WAN Optimization.'
choices:
- 'disable'
- 'enable'
tunnel-sharing:
type: str
description: 'Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.'
choices:
- 'private'
- 'shared'
- 'express-shared'
ftp:
description: no description
type: dict
required: false
suboptions:
byte-caching:
type: str
description: 'Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...'
choices:
- 'disable'
- 'enable'
log-traffic:
type: str
description: 'Enable/disable logging.'
choices:
- 'disable'
- 'enable'
prefer-chunking:
type: str
description: 'Select dynamic or fixed-size data chunking for WAN Optimization.'
choices:
- 'dynamic'
- 'fix'
protocol-opt:
type: str
description: 'Select Protocol specific optimitation or generic TCP optimization.'
choices:
- 'protocol'
- 'tcp'
secure-tunnel:
type: str
description: 'Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).'
choices:
- 'disable'
- 'enable'
ssl:
type: str
description: 'Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.'
choices:
- 'disable'
- 'enable'
status:
type: str
description: 'Enable/disable WAN Optimization.'
choices:
- 'disable'
- 'enable'
tunnel-sharing:
type: str
description: 'Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.'
choices:
- 'private'
- 'shared'
- 'express-shared'
http:
description: no description
type: dict
required: false
suboptions:
byte-caching:
type: str
description: 'Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...'
choices:
- 'disable'
- 'enable'
log-traffic:
type: str
description: 'Enable/disable logging.'
choices:
- 'disable'
- 'enable'
prefer-chunking:
type: str
description: 'Select dynamic or fixed-size data chunking for WAN Optimization.'
choices:
- 'dynamic'
- 'fix'
protocol-opt:
type: str
description: 'Select Protocol specific optimitation or generic TCP optimization.'
choices:
- 'protocol'
- 'tcp'
secure-tunnel:
type: str
description: 'Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).'
choices:
- 'disable'
- 'enable'
ssl:
type: str
description: 'Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.'
choices:
- 'disable'
- 'enable'
status:
type: str
description: 'Enable/disable WAN Optimization.'
choices:
- 'disable'
- 'enable'
tunnel-sharing:
type: str
description: 'Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.'
choices:
- 'private'
- 'shared'
- 'express-shared'
mapi:
description: no description
type: dict
required: false
suboptions:
byte-caching:
type: str
description: 'Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...'
choices:
- 'disable'
- 'enable'
log-traffic:
type: str
description: 'Enable/disable logging.'
choices:
- 'disable'
- 'enable'
secure-tunnel:
type: str
description: 'Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).'
choices:
- 'disable'
- 'enable'
status:
type: str
description: 'Enable/disable WAN Optimization.'
choices:
- 'disable'
- 'enable'
tunnel-sharing:
type: str
description: 'Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.'
choices:
- 'private'
- 'shared'
- 'express-shared'
tcp:
description: no description
type: dict
required: false
suboptions:
byte-caching:
type: str
description: 'Enable/disable byte-caching. Byte caching reduces the amount of traffic by caching file data sent across the WAN and i...'
choices:
- 'disable'
- 'enable'
byte-caching-opt:
type: str
description: 'Select whether TCP byte-caching uses system memory only or both memory and disk space.'
choices:
- 'mem-only'
- 'mem-disk'
log-traffic:
type: str
description: 'Enable/disable logging.'
choices:
- 'disable'
- 'enable'
port:
type: str
description: 'Port numbers or port number ranges for TCP. Only packets with a destination port number that matches this port number ...'
secure-tunnel:
type: str
description: 'Enable/disable securing the WAN Opt tunnel using SSL. Secure and non-secure tunnels use the same TCP port (7810).'
choices:
- 'disable'
- 'enable'
ssl:
type: str
description: 'Enable/disable SSL/TLS offloading (hardware acceleration) for traffic in this tunnel.'
choices:
- 'disable'
- 'enable'
ssl-port:
description: 'Port numbers or port number ranges on which to expect HTTPS traffic for SSL/TLS offloading.'
type: int
status:
type: str
description: 'Enable/disable WAN Optimization.'
choices:
- 'disable'
- 'enable'
tunnel-sharing:
type: str
description: 'Tunnel sharing mode for aggressive/non-aggressive and/or interactive/non-interactive protocols.'
choices:
- 'private'
- 'shared'
- 'express-shared'
'''
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: Configure WAN optimization profiles.
fmgr_wanopt_profile:
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>
state: <value in [present, absent]>
wanopt_profile:
auth-group: <value of string>
comments: <value of string>
name: <value of string>
transparent: <value in [disable, enable]>
cifs:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
prefer-chunking: <value in [dynamic, fix]>
protocol-opt: <value in [protocol, tcp]>
secure-tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
ftp:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
prefer-chunking: <value in [dynamic, fix]>
protocol-opt: <value in [protocol, tcp]>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
http:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
prefer-chunking: <value in [dynamic, fix]>
protocol-opt: <value in [protocol, tcp]>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
mapi:
byte-caching: <value in [disable, enable]>
log-traffic: <value in [disable, enable]>
secure-tunnel: <value in [disable, enable]>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
tcp:
byte-caching: <value in [disable, enable]>
byte-caching-opt: <value in [mem-only, mem-disk]>
log-traffic: <value in [disable, enable]>
port: <value of string>
secure-tunnel: <value in [disable, enable]>
ssl: <value in [disable, enable]>
ssl-port: <value of integer>
status: <value in [disable, enable]>
tunnel-sharing: <value in [private, shared, express-shared]>
'''
RETURN = '''
request_url:
description: The full url requested
returned: always
type: str
sample: /sys/login/user
response_code:
description: The status of api request
returned: always
type: int
sample: 0
response_message:
description: The descriptive message of the api response
type: str
returned: always
sample: OK.
'''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import check_galaxy_version
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import check_parameter_bypass
def main():
jrpc_urls = [
'/pm/config/adom/{adom}/obj/wanopt/profile',
'/pm/config/global/obj/wanopt/profile'
]
perobject_jrpc_urls = [
'/pm/config/adom/{adom}/obj/wanopt/profile/{profile}',
'/pm/config/global/obj/wanopt/profile/{profile}'
]
url_params = ['adom']
module_primary_key = 'name'
module_arg_spec = {
'enable_log': {
'type': 'bool',
'required': False,
'default': False
},
'forticloud_access_token': {
'type': 'str',
'required': False,
'no_log': True
},
'proposed_method': {
'type': 'str',
'required': False,
'choices': [
'set',
'update',
'add'
]
},
'bypass_validation': {
'type': 'bool',
'required': False,
'default': False
},
'workspace_locking_adom': {
'type': 'str',
'required': False
},
'workspace_locking_timeout': {
'type': 'int',
'required': False,
'default': 300
},
'rc_succeeded': {
'required': False,
'type': 'list'
},
'rc_failed': {
'required': False,
'type': 'list'
},
'state': {
'type': 'str',
'required': True,
'choices': [
'present',
'absent'
]
},
'adom': {
'required': True,
'type': 'str'
},
'wanopt_profile': {
'required': False,
'type': 'dict',
'revision': {
'6.0.0': True,
'6.2.1': True,
'6.2.3': True,
'6.2.5': True,
'6.4.0': True,
'6.4.2': True,
'6.4.5': True,
'7.0.0': True
},
'options': {
'auth-group': {
'required': False,
'revision': {
'6.0.0': True,
'6.2.1': True,
'6.2.3': True,
'6.2.5': True,
'6.4.0': True,
'6.4.2': True,
'6.4.5': True,
'7.0.0': True
},
'type': 'str'
},
'comments': {
'required': False,
'revision': {
'6.0.0': True,
'6.2.1': True,
'6.2.3': True,
'6.2.5': True,
'6.4.0': True,
'6.4.2': True,
'6.4.5': True,
'7.0.0': True
},
'type': 'str'
},
'name': {
'required': True,
'revision': {
'6.0.0': True,
'6.2.1': True,
'6.2.3': True,
'6.2.5': True,
'6.4.0': True,
'6.4.2': True,
'6.4.5': True,
'7.0.0': True
},
'type': 'str'
},
'transparent': {
'required': False,
'revision': {
'6.0.0': True,
'6.2.1': True,
'6.2.3': True,
'6.2.5': True,
'6.4.0': True,
'6.4.2': True,
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'cifs': {
'required': False,
'type': 'dict',
'options': {
'byte-caching': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'log-traffic': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'prefer-chunking': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'dynamic',
'fix'
],
'type': 'str'
},
'protocol-opt': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'protocol',
'tcp'
],
'type': 'str'
},
'secure-tunnel': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'status': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'tunnel-sharing': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'private',
'shared',
'express-shared'
],
'type': 'str'
}
}
},
'ftp': {
'required': False,
'type': 'dict',
'options': {
'byte-caching': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'log-traffic': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'prefer-chunking': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'dynamic',
'fix'
],
'type': 'str'
},
'protocol-opt': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'protocol',
'tcp'
],
'type': 'str'
},
'secure-tunnel': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'ssl': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'status': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'tunnel-sharing': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'private',
'shared',
'express-shared'
],
'type': 'str'
}
}
},
'http': {
'required': False,
'type': 'dict',
'options': {
'byte-caching': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'log-traffic': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'prefer-chunking': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'dynamic',
'fix'
],
'type': 'str'
},
'protocol-opt': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'protocol',
'tcp'
],
'type': 'str'
},
'secure-tunnel': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'ssl': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'status': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'tunnel-sharing': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'private',
'shared',
'express-shared'
],
'type': 'str'
}
}
},
'mapi': {
'required': False,
'type': 'dict',
'options': {
'byte-caching': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'log-traffic': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'secure-tunnel': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'status': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'tunnel-sharing': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'private',
'shared',
'express-shared'
],
'type': 'str'
}
}
},
'tcp': {
'required': False,
'type': 'dict',
'options': {
'byte-caching': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'byte-caching-opt': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'mem-only',
'mem-disk'
],
'type': 'str'
},
'log-traffic': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'port': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'type': 'str'
},
'secure-tunnel': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'ssl': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'ssl-port': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'type': 'int'
},
'status': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'disable',
'enable'
],
'type': 'str'
},
'tunnel-sharing': {
'required': False,
'revision': {
'6.4.5': True,
'7.0.0': True
},
'choices': [
'private',
'shared',
'express-shared'
],
'type': 'str'
}
}
}
}
}
}
params_validation_blob = []
check_galaxy_version(module_arg_spec)
module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'wanopt_profile'),
supports_check_mode=False)
fmgr = None
if module._socket_path:
connection = Connection(module._socket_path)
connection.set_option('enable_log', module.params['enable_log'] if 'enable_log' in module.params else False)
connection.set_option('forticloud_access_token',
module.params['forticloud_access_token'] if 'forticloud_access_token' in module.params else None)
fmgr = NAPIManager(jrpc_urls, perobject_jrpc_urls, module_primary_key, url_params, module, connection, top_level_schema_name='data')
fmgr.validate_parameters(params_validation_blob)
fmgr.process_curd(argument_specs=module_arg_spec)
else:
module.fail_json(msg='MUST RUN IN HTTPAPI MODE')
module.exit_json(meta=module.params)
if __name__ == '__main__':
main()