Get a list of FortiFlex configurations
Use the fortiflexvm_configs_list_info module to get a list of configurations from the FortiFlex API using the provided credentials and program serial number.
Parameters
The following parameters are included:
|
Parameter |
Type |
Description |
|---|---|---|
|
|
String (Optional) |
The username to authenticate. If not declared, the code will read the environment variable |
password
|
String (Optional) |
The password to authenticate. If not declared, the code will read the environment variable |
|
|
String |
The serial number of the program to get configurations for. |
Example
The following is an example use of this module:
- name: Get list of Flex VM Configurations for a Program
hosts: localhost
collections:
- fortinet.fortiflexvm
vars:
username: "<your_own_value>"
password: "<your_own_value>"
tasks:
- name: Get configs list
fortinet.fortiflexvm.fortiflexvm_configs_list_info:
username: "{{ username }}"
password: "{{ password }}"
programSerialNumber: "ELAVMS000000XXXX"
register: result
- name: Display response
debug:
var: result.configs
Return values
The following parameters are returned:
|
Parameter |
Type Returned |
Description |
|---|---|---|
|
|
Dictionary |
The list of configurations for the specified program. |
The configs dictionary includes:
|
Parameter |
Type Returned |
Description |
|---|---|---|
|
|
Integer |
The ID of the configuration. |
|
|
String |
The name of the configuration. |
|
|
String |
The program serial number the configuration belongs to. |
status
|
String |
The status of the configuration. |
|
|
Dictionary (Changed) |
The FortiGate Virtual Machine - Service Bundle. |
|
|
Dictionary (Changed) |
The FortiManager Virtual Machine. |
|
|
Dictionary (Changed) |
The FortiWeb Virtual Machine - Service Bundle. |
|
|
Dictionary (Changed) |
The FortiGate Virtual Machine - A La Carte Services. |
|
|
Dictionary (Changed) |
The FortiAnalyzer Virtual Machine. |
|
|
Dictionary (Changed) |
The FortiPortal Virtual Machine. |
The fortigateBundle dictionary includes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
String |
The number of CPUs. This value can be |
service
|
String |
The value can be either |
|
|
Integer |
The number of VDOMs between 0 and 500. The default value is 0. |
The fortiManager dictionary includes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
Integer |
The number of managed devices between 1 and 100000. |
|
|
Integer |
The number of ADOMs between 1 and 100000. |
The fortiWeb dictionary includes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
String |
The number of CPUs. This value can be |
service
|
String |
The service package can be |
The fortiGateLCS dictionary includes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
Integer |
The number of CPUs between 1 and 96. |
fortiGuardServices
|
List |
The FortiGuard services this FortiGate Virtual Machine supports. The default value is an empty list but may contain |
|
|
String |
The value can be |
|
|
Integer |
The number of VDOMs between 1 and 500. |
|
|
List |
The cloud services this FortiGate Virtual Machine supports. The default value is an empty list but may contain |
The fortiAnalyzer dictionary includes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
Integer |
The daily storage (GB) between 5 and 8300. |
adom
|
Integer |
The number of ADOMs between 0 and 1200. |
|
|
String |
The support service. |
The fortiPortal dictionary includes:
|
Attribute |
Type |
Description |
|---|---|---|
|
|
String |
The number of managed devices between 0 and 100000. |