Try Spotterno description
| "added in version" 2.2.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
cloud_orchestawstemplate_autoscaletgwnewvpc:
availability-zones: <value of string>
bgp-asn: <value of integer>
custom-asset-container: <value of string>
custom-asset-directory: <value of string>
custom-identifier: <value of string>
faz-autoscale-admin-password: <value of string>
faz-autoscale-admin-username: <value of string>
faz-custom-private-ipaddress: <value of string>
faz-instance-type: <value in [h1.2xlarge, h1.4xlarge, h1.8xlarge, ...]>
faz-integration-options: <value in [no, yes]>
faz-version: <value of string>
fgt-admin-cidr: <value of string>
fgt-admin-port: <value of integer>
fgt-instance-type: <value in [t2.small, c5.large, c5.xlarge, ...]>
fgt-psk-secret: <value of string>
fgtasg-cool-down: <value of integer>
fgtasg-desired-capacity-byol: <value of integer>
fgtasg-desired-capacity-payg: <value of integer>
fgtasg-health-check-grace-period: <value of integer>
fgtasg-max-size-byol: <value of integer>
fgtasg-max-size-payg: <value of integer>
fgtasg-min-size-byol: <value of integer>
fgtasg-min-size-payg: <value of integer>
fgtasg-scale-in-threshold: <value of integer>
fgtasg-scale-out-threshold: <value of integer>
fos-version: <value of string>
get-license-grace-period: <value of integer>
heartbeat-delay-allowance: <value of integer>
heartbeat-interval: <value of integer>
heartbeat-loss-count: <value of integer>
key-pair-name: <value of string>
lifecycle-hook-timeout: <value of integer>
name: <value of string>
notification-email: <value of string>
primary-election-timeout: <value of integer>
public-subnet1-cidr: <value of string>
public-subnet2-cidr: <value of string>
resource-tag-prefix: <value of string>
s3-bucket-name: <value of string>
s3-key-prefix: <value of string>
sync-recovery-count: <value of integer>
terminate-unhealthy-vm: <value in [no, yes]>
transit-gateway-id: <value of string>
transit-gateway-support-options: <value in [create one, use an existing one]>
use-custom-asset-location: <value in [no, yes]>
vpc-cidr: <value of string>
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
cloud_orchestawstemplate_autoscaletgwnewvpc:
description: the top level parameters set
required: false
suboptions:
availability-zones:
description: no description
type: str
bgp-asn:
description: no description
type: int
custom-asset-container:
description: no description
type: str
custom-asset-directory:
description: no description
type: str
custom-identifier:
description: no description
type: str
faz-autoscale-admin-password:
description: description
type: str
faz-autoscale-admin-username:
description: no description
type: str
faz-custom-private-ipaddress:
description: no description
type: str
faz-instance-type:
choices:
- h1.2xlarge
- h1.4xlarge
- h1.8xlarge
- m5.large
- m5.xlarge
- m5.2xlarge
- m5.4xlarge
- m5.12xlarge
- t2.medium
- t2.large
- t2.xlarge
description: no description
type: str
faz-integration-options:
choices:
- 'no'
- 'yes'
description: no description
type: str
faz-version:
description: no description
type: str
fgt-admin-cidr:
description: no description
type: str
fgt-admin-port:
description: no description
type: int
fgt-instance-type:
choices:
- t2.small
- c5.large
- c5.xlarge
- c5.2xlarge
- c5.4xlarge
- c5.9xlarge
description: no description
type: str
fgt-psk-secret:
description: no description
type: str
fgtasg-cool-down:
description: no description
type: int
fgtasg-desired-capacity-byol:
description: no description
type: int
fgtasg-desired-capacity-payg:
description: no description
type: int
fgtasg-health-check-grace-period:
description: no description
type: int
fgtasg-max-size-byol:
description: no description
type: int
fgtasg-max-size-payg:
description: no description
type: int
fgtasg-min-size-byol:
description: no description
type: int
fgtasg-min-size-payg:
description: no description
type: int
fgtasg-scale-in-threshold:
description: no description
type: int
fgtasg-scale-out-threshold:
description: no description
type: int
fos-version:
description: no description
type: str
get-license-grace-period:
description: no description
type: int
heartbeat-delay-allowance:
description: no description
type: int
heartbeat-interval:
description: no description
type: int
heartbeat-loss-count:
description: no description
type: int
key-pair-name:
description: no description
type: str
lifecycle-hook-timeout:
description: no description
type: int
name:
description: no description
type: str
notification-email:
description: no description
type: str
primary-election-timeout:
description: no description
type: int
public-subnet1-cidr:
description: no description
type: str
public-subnet2-cidr:
description: no description
type: str
resource-tag-prefix:
description: no description
type: str
s3-bucket-name:
description: no description
type: str
s3-key-prefix:
description: no description
type: str
sync-recovery-count:
description: no description
type: int
terminate-unhealthy-vm:
choices:
- 'no'
- 'yes'
description: no description
type: str
transit-gateway-id:
description: no description
type: str
transit-gateway-support-options:
choices:
- create one
- use an existing one
description: no description
type: str
use-custom-asset-location:
choices:
- 'no'
- 'yes'
description: no description
type: str
vpc-cidr:
description: no description
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list