fortinet.fortios.fortios_system_vmlicense – Update VM license using uploaded file. Reboots immediately if successful in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_system_vmlicense.
New in version 2.8: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vmlicense category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
Requirements
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| host
string
|
FortiOS or FortiGate IP address.
|
||
| https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol.
|
|
| password
string
|
Default:
""
|
FortiOS or FortiGate password.
|
|
| ssl_verify
boolean
added in 2.9 of fortinet.fortios
|
|
Ensures FortiGate certificate must be verified by a proper CA.
|
|
| system_vmlicense
dictionary
|
Update VM license using uploaded file. Reboots immediately if successful.
|
||
| file_content
string
|
Provided when uploading a file: base64 encoded file data. Must not contain whitespace or other invalid base64 characters. Must be included in HTTP body.
|
||
| username
string
|
FortiOS or FortiGate username.
|
||
| vdom
string
|
Default:
"root"
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.
|
|
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: no
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 80
license_file: ./FGVMXXXXXX-VM00.lic
license_file_content: "{{ lookup( 'file', license_file) }}"
encoded_license: "{{ license_file_content | string | b64encode }}"
tasks:
- name: Update VM license using uploaded file. Reboots immediately if successful.
fortios_system_vmlicense:
vdom: "{{ vdom }}"
system_vmlicense:
file_content: "{{ encoded_license }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
POST
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
vmlicense
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
system
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Frank Shen(@frankshen01)
- Link Zheng (@chillancezen)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_vmlicense_module.html