fortinet.fortiflexvm.fortiflexvm_configs_create (1.0.0) — module

Create a new FlexVM Configuration.

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

Authors: Xinwei Du (@DrMofu)

Install collection

Install with ansible-galaxy collection install fortinet.fortiflexvm:==1.0.0


Add to requirements.yml

  collections:
    - name: fortinet.fortiflexvm
      version: 1.0.0

Description

This module creates a new FlexVM Configuration under a program.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create VM configuration
  hosts: localhost
  collections:
    - fortinet.fortiflexvm
  vars:
    username: "<your_own_value>"
    password: "<your_own_value>"
  tasks:
    - name: Create a Virtual Machine configuration
      fortinet.fortiflexvm.fortiflexvm_configs_create:
        username: "{{ username }}"
        password: "{{ password }}"
        programSerialNumber: "ELAVMS000000XXXX"
        name: "ansible"

        # Please only use one of the following.

        fortiGateBundle:
          cpu: "2" # "1", "2", "4", "8", "16", "32", "2147483647"
          service: "FC" # "FC", "UTM", "ENT", "ATP"
          vdom: 10 # 0 ~ 500

        # fortiManager:
        #   device: 1 # 1 ~ 100000
        #   adom: 1 # 1 ~ 100000

        # fortiWeb:
        #   cpu: "4" # "1", "2", "4", "8", "16"
        #   service: "FWBSTD" # "FWBSTD" or "FWBADV"

        # fortiGateLCS:
        #   cpu: 4 # 1 ~ 96
        #   fortiGuardServices: [] # "IPS", "AVDB", "FURL", "IOTH", "FGSA", "ISSS"
        #   supportService: "FC247" # "FC247", "ASET"
        #   vdom: 1 # 1 ~ 500
        #   cloudServices: ["FAMS", "SWNM"] # "FAMS", "SWNM", "FMGC", "AFAC"

        # fortiAnalyzer:
        #   storage: 5 # 5 ~ 8300
        #   adom: 1 # 0 ~ 1200
        #   service: "FAZFC247" # "FAZFC247"

        # fortiPortal:
        #   device: 1 # 0 ~ 100000

      register: result

    - name: Display response
      debug:
        var: result.configs

Inputs

    
name:
    description:
    - The name of your Flex VM Configuration.
    required: true
    type: str

fortiWeb:
    description:
    - FortiWeb Virtual Machine - Service Bundle.
    required: false
    suboptions:
      cpu:
        choices:
        - '1'
        - '2'
        - '4'
        - '8'
        - '16'
        description:
        - Number of CPUs. The value of this attribute is one of "1", "2" "4", "8" or "16".
        required: true
        type: str
      service:
        choices:
        - FWBSTD
        - FWBADV
        description:
        - Service Package. Valid values are "FWBSTD" (Standard) or "FWBADV" (Advanced).
        required: true
        type: str
    type: dict

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

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

fortiPortal:
    description:
    - FortiPortal Virtual Machine.
    required: false
    suboptions:
      device:
        description:
        - Number of managed devices. A number between 0 and 100000 (inclusive).
        required: true
        type: int
    type: dict

fortiGateLCS:
    description:
    - FortiGate Virtual Machine - A La Carte Services.
    required: false
    suboptions:
      cloudServices:
        default: []
        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", "FMGC", "AFAC"].
        elements: str
        required: false
        type: list
      cpu:
        description:
        - The number of CPUs. A number between 1 and 96 (inclusive).
        required: true
        type: int
      fortiGuardServices:
        default: []
        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", "FURL", "IOTH",
          "FGSA", "ISSS"].
        elements: str
        required: false
        type: list
      supportService:
        choices:
        - FC247
        - ASET
        description:
        - Valid values are "FC247" (FortiCare 24x7) or "ASET" (FortiCare Elite).
        required: true
        type: str
      vdom:
        description:
        - Number of VDOMs. A number between 1 and 500 (inclusive).
        required: true
        type: int
    type: dict

fortiManager:
    description:
    - FortiManager Virtual Machine.
    required: false
    suboptions:
      adom:
        description:
        - Number of ADOMs. A number between 1 and 100000 (inclusive).
        required: true
        type: int
      device:
        description:
        - Number of managed devices. A number between 1 and 100000 (inclusive).
        required: true
        type: int
    type: dict

fortiAnalyzer:
    description:
    - FortiAnalyzer Virtual Machine.
    required: false
    suboptions:
      adom:
        description:
        - Number of ADOMs. A number between 0 and 1200 (inclusive).
        required: true
        type: int
      service:
        choices:
        - FAZFC247
        description:
        - Support Service. Currently, the only available option is "FAZFC247" (FortiCare
          Premium). The default value is "FAZFC247".
        required: true
        type: str
      storage:
        description:
        - Daily Storage (GB). A number between 5 and 8300 (inclusive).
        required: true
        type: int
    type: dict

fortiGateBundle:
    description:
    - FortiGate Virtual Machine - Service Bundle.
    required: false
    suboptions:
      cpu:
        choices:
        - '1'
        - '2'
        - '4'
        - '8'
        - '16'
        - '32'
        - '2147483647'
        description:
        - The number of CPUs. The value of this attribute is one of "1", "2", "4", "8",
          "16",  "32" or "2147483647" (unlimited).
        required: true
        type: str
      service:
        choices:
        - FC
        - UTM
        - ENT
        - ATP
        description:
        - The value of this attribute is one of "FC" (FortiCare), "UTM", "ENT" (Enterprise)
          or "ATP".
        required: true
        type: str
      vdom:
        default: 0
        description:
        - Number of VDOMs. A number between 0 and 500 (inclusive). The default number
          is 0.
        required: false
        type: int
    type: dict

programSerialNumber:
    description:
    - The serial number of your Flex VM Program.
    required: true
    type: str

Outputs

configs:
  contains:
    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
    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", "FMGC",
            "AFAC"].
          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", "FURL",
            "IOTH", "FGSA", "ISSS"].
          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: The configuration you create.
  returned: always
  type: dict