drmofu.fortiflexvm.fortiflexvm_configs_list_info (2.0.0) — module

Get list of FortiFlex Configurations.

| "added in version" 1.0.0 of drmofu.fortiflexvm"

Authors: Xinwei Du (@DrMofu)

Install collection

Install with ansible-galaxy collection install drmofu.fortiflexvm:==2.0.0


Add to requirements.yml

  collections:
    - name: drmofu.fortiflexvm
      version: 2.0.0

Description

This module retrieves a list of configs from FortiFlexVM API using the provided credentials and program serial number.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of FortiFlex 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

Inputs

    
password:
    description:
    - The password to authenticate. If not declared, the code will read the environment
      variable FORTIFLEX_ACCESS_PASSWORD.
    required: false
    type: str

username:
    description:
    - The username to authenticate. If not declared, the code will read the environment
      variable FORTIFLEX_ACCESS_USERNAME.
    required: false
    type: str

programSerialNumber:
    description:
    - The serial number of the program to get configs for.
    required: true
    type: str

Outputs

configs:
  contains:
    fortiADC:
      contains:
        cpu:
          description:
          - Number of CPUs. The value of this attribute is one of "1", "2", "4", "8",
            "16" or "32".
          returned: always
          type: str
        service:
          description:
          - Support Service. "FDVSTD" (Standard), "FDVADV" (Advanced) or "FDVFC247"
            (FortiCare Premium).
          returned: always
          type: str
      description:
      - FortiADC Virtual Machine.
      returned: changed
      type: dict
    fortiAnalyzer:
      contains:
        adom:
          description:
          - Number of ADOMs. A number between 0 and 1200 (inclusive).
          returned: always
          type: int
        service:
          description:
          - Support Service. Currently, the only available option is "FAZFC247" (FortiCare
            Premium).
          - The default value is "FAZFC247".
          returned: always
          type: str
        storage:
          description:
          - Daily Storage (GB). A number between 5 and 8300 (inclusive).
          returned: always
          type: int
      description:
      - FortiAnalyzer Virtual Machine.
      returned: changed
      type: dict
    fortiGateBundle:
      contains:
        cpu:
          description:
          - The number of CPUs. The value of this attribute is one of "1", "2", "4",
            "8", "16",  "32" or "2147483647" (unlimited).
          returned: always
          type: str
        service:
          description:
          - he value of this attribute is one of "FC" (FortiCare), "UTM", "ENT" (Enterprise)
            or "ATP".
          returned: always
          type: str
        vdom:
          description:
          - Number of VDOMs. A number between 0 and 500 (inclusive). The default number
            is 0.
          returned: always
          type: int
      description:
      - FortiGate Virtual Machine - Service Bundle.
      returned: changed
      type: dict
    fortiGateHardware:
      contains:
        addons:
          description:
          - Addons. Only support "NONE" now, will support "FGHWFCELU" (FortiCare Elite
            Upgrade) in the future.
          returned: always
          type: str
        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).
          returned: always
          type: str
        service:
          description:
          - Support Service. Possible values are FGHWFC247 (FortiCare Premium), FGHWFCEL
            (FortiCare Elite),
          - FDVFC247 (ATP), FGHWUTP (UTP) or FGHWENT (Enterprise).
          returned: always
          type: str
      description:
      - FortiGate Hardware.
      returned: changed
      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"].
          returned: always
          type: list
        cpu:
          description:
          - The number of CPUs. A number between 1 and 96 (inclusive).
          returned: always
          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"].
          returned: always
          type: list
        supportService:
          description:
          - Valid values are "FC247" (FortiCare 24x7) or "ASET" (FortiCare Elite).
          returned: always
          type: str
        vdom:
          description:
          - Number of VDOMs. A number between 1 and 500 (inclusive).
          returned: always
          type: int
      description:
      - FortiGate Virtual Machine - A La Carte Services.
      returned: changed
      type: dict
    fortiManager:
      contains:
        adom:
          description:
          - Number of ADOMs. A number between 1 and 100000 (inclusive).
          returned: always
          type: int
        device:
          description:
          - Number of managed devices. A number between 1 and 100000 (inclusive).
          returned: always
          type: int
      description:
      - FortiManager Virtual Machine.
      returned: changed
      type: dict
    fortiPortal:
      contains:
        device:
          description:
          - Number of managed devices. A number between 0 and 100000 (inclusive).
          returned: always
          type: str
      description:
      - FortiPortal Virtual Machine.
      returned: changed
      type: dict
    fortiWeb:
      contains:
        cpu:
          description:
          - Number of CPUs. The value of this attribute is one of "1", "2", "4", "8"
            or "16".
          returned: always
          type: str
        service:
          description:
          - Service Package. Valid values are "FWBSTD" (Standard) or "FWBADV" (Advanced).
          returned: always
          type: str
      description:
      - FortiWeb Virtual Machine - Service Bundle.
      returned: changed
      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