Try Spotterno description
| "added in version" 2.2.0 of fortinet.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 fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: No description
fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc:
# 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: present # <value in [present, absent]>
cloud_orchestawstemplate_autoscalenewvpc:
availability_zones: <string>
custom_asset_container: <string>
custom_asset_directory: <string>
custom_identifier: <string>
faz_autoscale_admin_password: <list or string>
faz_autoscale_admin_username: <string>
faz_custom_private_ipaddress: <string>
faz_instance_type: <value in [h1.2xlarge, h1.4xlarge, h1.8xlarge, ...]>
faz_integration_options: <value in [no, yes]>
faz_version: <string>
fgt_admin_cidr: <string>
fgt_admin_port: <integer>
fgt_instance_type: <value in [t2.small, c5.large, c5.xlarge, ...]>
fgt_psk_secret: <string>
fgtasg_cool_down: <integer>
fgtasg_desired_capacity_byol: <integer>
fgtasg_desired_capacity_payg: <integer>
fgtasg_health_check_grace_period: <integer>
fgtasg_max_size_byol: <integer>
fgtasg_max_size_payg: <integer>
fgtasg_min_size_byol: <integer>
fgtasg_min_size_payg: <integer>
fgtasg_scale_in_threshold: <integer>
fgtasg_scale_out_threshold: <integer>
fos_version: <string>
get_license_grace_period: <integer>
heartbeat_delay_allowance: <integer>
heartbeat_interval: <integer>
heartbeat_loss_count: <integer>
internal_balancer_dns_name: <string>
internal_balancing_options: <value in [add a new internal load balancer, use a load balancer specified below, do not need one]>
internal_target_group_health_check_path: <string>
key_pair_name: <string>
lifecycle_hook_timeout: <integer>
loadbalancing_health_check_threshold: <integer>
loadbalancing_traffic_port: <integer>
loadbalancing_traffic_protocol: <value in [HTTPS, HTTP, TCP]>
name: <string>
notification_email: <string>
primary_election_timeout: <integer>
private_subnet1_cidr: <string>
private_subnet2_cidr: <string>
public_subnet1_cidr: <string>
public_subnet2_cidr: <string>
resource_tag_prefix: <string>
s3_bucket_name: <string>
s3_key_prefix: <string>
sync_recovery_count: <integer>
terminate_unhealthy_vm: <value in [no, yes]>
use_custom_asset_location: <value in [no, yes]>
vpc_cidr: <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
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
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.
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.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
cloud_orchestawstemplate_autoscalenewvpc:
description: The top level parameters set.
required: false
suboptions:
availability-zones:
description: Deprecated, please rename it to availability_zones.
type: str
custom-asset-container:
description: Deprecated, please rename it to custom_asset_container.
type: str
custom-asset-directory:
description: Deprecated, please rename it to custom_asset_directory.
type: str
custom-identifier:
description: Deprecated, please rename it to custom_identifier.
type: str
faz-autoscale-admin-password:
description: (list) Deprecated, please rename it to faz_autoscale_admin_password.
type: raw
faz-autoscale-admin-username:
description: Deprecated, please rename it to faz_autoscale_admin_username.
type: str
faz-custom-private-ipaddress:
description: Deprecated, please rename it to faz_custom_private_ipaddress.
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: Deprecated, please rename it to faz_instance_type.
type: str
faz-integration-options:
choices:
- 'no'
- 'yes'
description: Deprecated, please rename it to faz_integration_options.
type: str
faz-version:
description: Deprecated, please rename it to faz_version.
type: str
fgt-admin-cidr:
description: Deprecated, please rename it to fgt_admin_cidr.
type: str
fgt-admin-port:
description: Deprecated, please rename it to fgt_admin_port.
type: int
fgt-instance-type:
choices:
- t2.small
- c5.large
- c5.xlarge
- c5.2xlarge
- c5.4xlarge
- c5.9xlarge
description: Deprecated, please rename it to fgt_instance_type.
type: str
fgt-psk-secret:
description: Deprecated, please rename it to fgt_psk_secret.
type: str
fgtasg-cool-down:
description: Deprecated, please rename it to fgtasg_cool_down.
type: int
fgtasg-desired-capacity-byol:
description: Deprecated, please rename it to fgtasg_desired_capacity_byol.
type: int
fgtasg-desired-capacity-payg:
description: Deprecated, please rename it to fgtasg_desired_capacity_payg.
type: int
fgtasg-health-check-grace-period:
description: Deprecated, please rename it to fgtasg_health_check_grace_period.
type: int
fgtasg-max-size-byol:
description: Deprecated, please rename it to fgtasg_max_size_byol.
type: int
fgtasg-max-size-payg:
description: Deprecated, please rename it to fgtasg_max_size_payg.
type: int
fgtasg-min-size-byol:
description: Deprecated, please rename it to fgtasg_min_size_byol.
type: int
fgtasg-min-size-payg:
description: Deprecated, please rename it to fgtasg_min_size_payg.
type: int
fgtasg-scale-in-threshold:
description: Deprecated, please rename it to fgtasg_scale_in_threshold.
type: int
fgtasg-scale-out-threshold:
description: Deprecated, please rename it to fgtasg_scale_out_threshold.
type: int
fos-version:
description: Deprecated, please rename it to fos_version.
type: str
get-license-grace-period:
description: Deprecated, please rename it to get_license_grace_period.
type: int
heartbeat-delay-allowance:
description: Deprecated, please rename it to heartbeat_delay_allowance.
type: int
heartbeat-interval:
description: Deprecated, please rename it to heartbeat_interval.
type: int
heartbeat-loss-count:
description: Deprecated, please rename it to heartbeat_loss_count.
type: int
internal-balancer-dns-name:
description: Deprecated, please rename it to internal_balancer_dns_name.
type: str
internal-balancing-options:
choices:
- add a new internal load balancer
- use a load balancer specified below
- do not need one
description: Deprecated, please rename it to internal_balancing_options.
type: str
internal-target-group-health-check-path:
description: Deprecated, please rename it to internal_target_group_health_check_path.
type: str
key-pair-name:
description: Deprecated, please rename it to key_pair_name.
type: str
lifecycle-hook-timeout:
description: Deprecated, please rename it to lifecycle_hook_timeout.
type: int
loadbalancing-health-check-threshold:
description: Deprecated, please rename it to loadbalancing_health_check_threshold.
type: int
loadbalancing-traffic-port:
description: Deprecated, please rename it to loadbalancing_traffic_port.
type: int
loadbalancing-traffic-protocol:
choices:
- HTTPS
- HTTP
- TCP
description: Deprecated, please rename it to loadbalancing_traffic_protocol.
type: str
name:
description: No description.
required: true
type: str
notification-email:
description: Deprecated, please rename it to notification_email.
type: str
primary-election-timeout:
description: Deprecated, please rename it to primary_election_timeout.
type: int
private-subnet1-cidr:
description: Deprecated, please rename it to private_subnet1_cidr.
type: str
private-subnet2-cidr:
description: Deprecated, please rename it to private_subnet2_cidr.
type: str
public-subnet1-cidr:
description: Deprecated, please rename it to public_subnet1_cidr.
type: str
public-subnet2-cidr:
description: Deprecated, please rename it to public_subnet2_cidr.
type: str
resource-tag-prefix:
description: Deprecated, please rename it to resource_tag_prefix.
type: str
s3-bucket-name:
description: Deprecated, please rename it to s3_bucket_name.
type: str
s3-key-prefix:
description: Deprecated, please rename it to s3_key_prefix.
type: str
sync-recovery-count:
description: Deprecated, please rename it to sync_recovery_count.
type: int
terminate-unhealthy-vm:
choices:
- 'no'
- 'yes'
description: Deprecated, please rename it to terminate_unhealthy_vm.
type: str
use-custom-asset-location:
choices:
- 'no'
- 'yes'
description: Deprecated, please rename it to use_custom_asset_location.
type: str
vpc-cidr:
description: Deprecated, please rename it to vpc_cidr.
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