fortinet / fortinet.fortiflexvm / 2.2.0 / module / fortiflexvm_configs_list_info Get list of FortiFlex Configurations. | "added in version" 1.0.0 of fortinet.fortiflexvm" Authors: Xinwei Du (@dux-fortinet)fortinet.fortiflexvm.fortiflexvm_configs_list_info (2.2.0) — module
Install with ansible-galaxy collection install fortinet.fortiflexvm:==2.2.0
collections: - name: fortinet.fortiflexvm version: 2.2.0
This module retrieves a list of configs from FortiFlexVM API using the provided credentials and program serial number.
- name: Get list of FortiFlex Configurations for a Program hosts: localhost vars: username: "<your_own_value>" password: "<your_own_value>" tasks: - name: Get configs list fortinet.fortiflexvm.fortiflexvm_configs_list_info: username: "{{ username }}" password: "{{ password }}" # accountId: 12345 # optional programSerialNumber: "ELAVMS000000XXXX" register: result - name: Display response ansible.builtin.debug: var: result.configs
password: description: - The password to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_PASSWORD. type: str username: description: - The username to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_USERNAME. type: str accountId: description: Account ID. type: int programSerialNumber: description: - The serial number of the program to get configs for. required: true type: str
configs: contains: accountId: description: The ID of the account associated with the program. returned: always sample: 12345 type: int fortiADC: contains: cpu: description: - Number of CPUs. The value of this attribute is one of "1", "2", "4", "8", "16" or "32". type: str service: description: - Support Service. "FDVSTD" (Standard), "FDVADV" (Advanced) or "FDVFC247" (FortiCare Premium). type: str description: - FortiADC Virtual Machine. type: dict fortiAnalyzer: contains: adom: description: - Number of ADOMs. A number between 0 and 1200 (inclusive). type: int service: description: - Support Service. Currently, the only available option is "FAZFC247" (FortiCare Premium). - The default value is "FAZFC247". type: str storage: description: - Daily Storage (GB). A number between 5 and 8300 (inclusive). type: int description: - FortiAnalyzer Virtual Machine. type: dict fortiClientEMSCloud: contains: EPP_ZTNA: description: - EPP/ATP + ZTNA/VPN (number of endpoints). - Value should be 0 or between 25 and 25000. type: int EPP_ZTNA_FGF: description: - EPP/ATP + ZTNA/VPN + FortiGuard Forensics (number of endpoints). - Value should be 0 or between 25 and 25000. type: int ZTNA: description: - ZTNA/VPN (number of endpoints). - Value should be 0 or between 25 and 25000. type: int ZTNA_FGF: description: - ZTNA/VPN + FortiGuard Forensics (number of endpoints). - Value should be 0 or between 25 and 25000. type: int addons: description: Addons. A list. Possible value is "BPS" ( FortiCare Best Practice). elements: str type: list chromebook: description: - Chromebook (number of endpoints). - Value should be 0 or between 25 and 25000. type: int description: - FortiClient EMS Cloud. type: dict fortiClientEMSOP: contains: EPP: description: - EPP/ATP + ZTNA/VPN (number of endpoints). - Value should be 0 or between 25 and 25000. type: int ZTNA: description: - ZTNA/VPN (number of endpoints). - Value should be 0 or between 25 and 25000. type: int addons: description: Addons. A list. Possible value is "BPS" ( FortiCare Best Practice). elements: str type: list chromebook: description: - Chromebook (number of endpoints). - Value should be 0 or between 25 and 25000. type: int service: description: - Support Services. Possible value is "FCTFC247" (FortiCare Premium) type: str description: - FortiClient EMS On-Prem. type: dict fortiCloudPrivate: contains: applications: description: Number of web applications. Number between 0 and 2000 (inclusive). type: int throughput: description: - Average Throughput (Mbps). - Possible values are 10, 25, 50, 75, 100, 150, 200, 250, 300, 350, 400, 450, 500, 600, - 700, 800, 900, 1000, 1500, 2000, 2500, 3000, 3500, 4000, 4500, 5000, 5500, 6000, 6500, - 7000, 7500, 8000, 8500, 9000, 9500, 10000. type: int description: - FortiWeb Cloud, Private. type: dict fortiCloudPublic: contains: applications: description: Number of web applications. Number between 0 and 2000 (inclusive). type: int throughput: description: - Average Throughput (Mbps). - Possible values are 25, 50, 75, 100, 150, 200, 250, 300, 350, 400, 450, 500, 600, - 700, 800, 900, 1000, 1500, 2000, 2500, 3000, 3500, 4000, 4500, 5000, 5500, 6000, 6500, - 7000, 7500, 8000, 8500, 9000, 9500, 10000. type: int description: - FortiWeb Cloud, Public. type: dict fortiEDR: contains: addons: description: Addons. A list. Possible value is "FEDRXDR" (XDR). elements: str type: list endpoints: description: Number of Endpoints. Read only. type: int service: description: Service package. "FEDRPDR" (Discover/Protect/Respond). type: str description: fortiEDR Cloud Configuration. type: dict fortiGateBundle: contains: cloudServices: description: - Cloud Services. The default value is an empty list. - It should contain zero, one or more elements of ["FGTFAMS", "FGTSWNM", "FGTSOCA", "FGTFAZC", "FGTSWOS", "FGTFSPA"]. elements: str type: list cpu: description: - The number of CPUs. The value of this attribute is one of "1", "2", "4", "8", "16", "32" or "2147483647" (unlimited). type: int fortiGuardServices: description: - Fortiguard Services. The default value is an empty list. - It should contain zero, one or more elements of ["FGTAVDB", "FGTFAIS", "FGTISSS", "FGTDLDB", "FGTFGSA", "FGTFCSS"]. elements: str type: list service: description: - The value of this attribute is one of "FC" (FortiCare), "UTP", "ENT" (Enterprise) or "ATP". type: str supportService: description: - Suport service. "FGTFCELU" or "NONE". Default is "NONE". type: str vdom: description: - Number of VDOMs. A number between 0 and 500 (inclusive). The default number is 0. type: int description: - FortiGate Virtual Machine - Service Bundle. type: dict fortiGateHardware: contains: addons: description: - Addons. Possible values are - NONE, FGHWFCELU (FortiCare Elite Upgrade), FGHWFAMS (FortiGate Cloud Management), - FGHWFAIS (AI-Based In-line Sandbox), FGHWSWNM (SD-WAN Underlay), FGHWDLDB (FortiGuard DLP), - FGHWFAZC (FortiAnalyzer Cloud), FGHWSOCA (SOCaaS), FGHWMGAS (Managed FortiGate), - FGHWSPAL (SD-WAN Connector for FortiSASE), FGHWFCSS (FortiConverter Service). elements: str type: list model: description: - The device model. Possible values are - FGT40F (FortiGate-40F), FGT60F (FortiGate-60F), FGT70F (FortiGate-70F), FGT80F (FortiGate-80F), - FG100F (FortiGate-100F), FGT60E (FortiGate-60E), FGT61F (FortiGate-61F), FG100E (FortiGate-100E), - FG101F (FortiGate-101F), FG200E (FortiGate-200E), FG200F (FortiGate-200F), FG201F (FortiGate-201F), - FG4H0F (FortiGate-400F), FG6H0F (FortiGate-600F), FWF40F (FortiWifi-40F), FWF60F (FortiWifi-60F), - FGR60F (FortiGateRugged-60F), FR70FB (FortiGateRugged-70F), FGT81F (FortiGate-81F), FG101E (FortiGate-101E), - FG4H1F (FortiGate-401F), FG1K0F (FortiGate-1000F), FG180F (FortiGate-1800F), F2K60F (FortiGate-2600F), - FG3K0F (FortiGate-3000F), FG3K1F (FortiGate-3001F), FG3K2F (FortiGate-3200F)... type: str service: description: - Support Service. Possible values are FGHWFC247 (FortiCare Premium), FGHWFCEL (FortiCare Elite), - FDVFC247 (ATP), FGHWUTP (UTP) or FGHWENT (Enterprise). type: str description: - FortiGate Hardware. type: dict fortiGateLCS: contains: cloudServices: description: - The cloud services this FortiGate Virtual Machine supports. The default value is an empty list. - It should contain zero, one or more elements of ["FAMS", "SWNM", "AFAC", "FAZC"]. elements: str type: list cpu: description: - The number of CPUs. A number between 1 and 96 (inclusive). type: int fortiGuardServices: description: - The fortiguard services this FortiGate Virtual Machine supports. The default value is an empty list. - It should contain zero, one or more elements of ["IPS", "AVDB", "FGSA", "DLDB", "FAIS", "FURLDNS"]. elements: str type: list supportService: description: - Valid values are "FC247" (FortiCare 24x7) or "ASET" (FortiCare Elite). type: str vdom: description: - Number of VDOMs. A number between 1 and 500 (inclusive). type: int description: - FortiGate Virtual Machine - A La Carte Services. type: dict fortiManager: contains: adom: description: - Number of ADOMs. A number between 1 and 100000 (inclusive). type: int device: description: - Number of managed devices. A number between 1 and 100000 (inclusive). type: int description: - FortiManager Virtual Machine. type: dict fortiPortal: contains: device: description: - Number of managed devices. A number between 0 and 100000 (inclusive). type: str description: - FortiPortal Virtual Machine. type: dict fortiSASE: contains: bandwidth: description: Number between 25 and 10,000 (inclusive). Value should be divisible by 25. type: int dedicatedIPs: description: Number between 4 and 65,534 (inclusive). type: int service: description: Service package. "FSASESTD" (Standard) or "FSASEADV" (Advanced). type: str users: description: - Number of users. Number between 50 and 50,000 (inclusive). - Number between 50 and 50,000 (inclusive). Value should be divisible by 25. type: int description: fortiSASE Cloud Configuration. type: dict fortiWeb: contains: cpu: description: - Number of CPUs. The value of this attribute is one of "1", "2", "4", "8" or "16". type: str service: description: - Service Package. Valid values are "FWBSTD" (Standard) or "FWBADV" (Advanced). type: str description: - FortiWeb Virtual Machine - Service Bundle. type: dict id: description: The ID of the configuration. returned: always sample: 21 type: int name: description: The name of the configuration. returned: always sample: Configuration Name type: str programSerialNumber: description: The program serial number the configuration belongs to. returned: always sample: ELAVMR0000000101 type: str status: description: The status of the configuration. returned: always sample: ACTIVE type: str description: List of configurations for the specified program serial number. returned: always type: list