Ansible Collection

The FortiFlex Ansible Collection can be used to run playbooks to interact with FortiFlex. The FortiFlex Ansible Collection can be found on GitHub and Ansible Galaxy.

You can get support from the Fortinet Inc. Technical Assistance Center or from the community engineering team by filing an issue in the GitHub issues page. For support with common Ansible issues, you can get support from the Ansible community.

Before you can begin to use the Ansible Collection, you must:

1. Install Python3.

2. Install Ansible.

   The Ansible core version 2.9.0 and later is required.

3. Install the latest FortiOS Galaxy Collection:

   ansible-galaxy collection install fortinet.fortiflexvm

   You can also choose another Galaxy version to match your FortiFlex device. See the FortiFlexVM Galaxy Versions and Release Notes for more recently released collections and install the ones mark latest for your devices.

4. Generate an API token (username and password) for FortiFlex. See FortiFlex API.

Modules included in the Ansible Collection allow you to:

• Create a new FortiFlex configuration

• Get a list of FortiFlex configurations

• Update a FortiFlex configuration

• Create hardware entitlements based on a FortiFlex configuration

• Get a list of existing entitlements for a FortiFlex configuration

• Get a list of the point usage for entitlements

• Update an existing entitlement

• Create VMs based on a FortiFlex configuration

• Regenerate a token for a VM

• Get a list of FortiFlex groups

• Get the next available tokens

• Get a list of FortiFlex programs

Additional Ansible Collection information in this section includes:

• Running your first playbook

• Index of all Ansible Collection environment variables