community.general.faz_device (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Add or remove a device or list of devices to FortiAnalyzer Device Manager. ADOM Capable.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: DISCOVER AND ADD DEVICE A PHYSICAL FORTIGATE
  faz_device:
    adom: "root"
    device_username: "admin"
    device_password: "admin"
    device_ip: "10.10.24.201"
    device_unique_name: "FGT1"
    device_serial: "FGVM000000117994"
    state: "present"
    mgmt_mode: "faz"
    os_type: "fos"
    os_ver: "5.0"
    minor_rev: 6

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: DISCOVER AND ADD DEVICE A VIRTUAL FORTIGATE
  faz_device:
    adom: "root"
    device_username: "admin"
    device_password: "admin"
    device_ip: "10.10.24.202"
    device_unique_name: "FGT2"
    mgmt_mode: "faz"
    os_type: "fos"
    os_ver: "5.0"
    minor_rev: 6
    state: "present"
    platform_str: "FortiGate-VM64"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: DELETE DEVICE FGT01
  faz_device:
    adom: "root"
    device_unique_name: "ansible-fgt01"
    mode: "delete"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: DELETE DEVICE FGT02
  faz_device:
    adom: "root"
    device_unique_name: "ansible-fgt02"
    mode: "delete"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: PROMOTE FGT01 IN FAZ BY IP
  faz_device:
    adom: "root"
    device_password: "fortinet"
    device_ip: "10.7.220.151"
    device_username: "ansible"
    mgmt_mode: "faz"
    mode: "promote"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: PROMOTE FGT02 IN FAZ
  faz_device:
    adom: "root"
    device_password: "fortinet"
    device_unique_name: "ansible-fgt02"
    device_username: "ansible"
    mgmt_mode: "faz"
    mode: "promote"

Inputs

    
adom:
    default: root
    description:
    - The ADOM the configuration should belong to.
    required: true
    type: str

mode:
    choices:
    - add
    - delete
    - promote
    default: add
    description:
    - Add or delete devices. Or promote unregistered devices that are in the FortiAnalyzer
      "waiting pool"
    required: false
    type: str

os_ver:
    choices:
    - unknown
    - '0.0'
    - '1.0'
    - '2.0'
    - '3.0'
    - '4.0'
    - '5.0'
    - '6.0'
    description:
    - Major OS rev of the device
    required: true
    type: str

os_type:
    choices:
    - unknown
    - fos
    - fsw
    - foc
    - fml
    - faz
    - fwb
    - fch
    - fct
    - log
    - fmg
    - fsa
    - fdd
    - fac
    description:
    - The os type of the device being added (default 0).
    required: true
    type: str

device_ip:
    description:
    - The IP of the device being added to FortiAnalyzer.
    required: false
    type: str

faz_quota:
    description:
    - Specifies the quota for the device in FAZ
    required: false
    type: str

mgmt_mode:
    choices:
    - unreg
    - fmg
    - faz
    - fmgfaz
    description:
    - Management Mode of the device you are adding.
    required: true
    type: str

platform_str:
    description:
    - Required for determine the platform for VM platforms. ie FortiGate-VM64
    required: false
    type: str

device_serial:
    description:
    - The serial number of the device being added to FortiAnalyzer.
    required: false
    type: str

os_minor_vers:
    description:
    - Minor OS rev of the device.
    required: true
    type: str

device_password:
    description:
    - The password of the device being added to FortiAnalyzer.
    required: false
    type: str

device_username:
    description:
    - The username of the device being added to FortiAnalyzer.
    required: false
    type: str

device_unique_name:
    description:
    - The desired "friendly" name of the device being added to FortiAnalyzer.
    required: false
    type: str

Outputs

api_result:
  description: full API response, includes status code and message
  returned: always
  type: str