fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc module – Cloud orchest awstemplate autoscale new vpc

Note

This module is part of the fortinet.fortimanager collection (version 2.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc.

New in fortinet.fortimanager 2.2.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

cloud_orchestawstemplate_autoscalenewvpc

dictionary

The top level parameters set.

availability_zones

string

Availability zones.

custom_asset_container

string

Custom asset container.

custom_asset_directory

string

Custom asset directory.

custom_identifier

string

Custom identifier.

faz_autoscale_admin_password

any

(list) Faz autoscale admin password.

faz_autoscale_admin_username

string

Faz autoscale admin username.

faz_custom_private_ipaddress

string

Faz custom private ipaddress.

faz_instance_type

string

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"

faz_integration_options

string

Faz integration options.

Choices:

  • "no"

  • "yes"

faz_version

string

Faz version.

fgt_admin_cidr

string

Fgt admin cidr.

fgt_admin_port

integer

Fgt admin port.

fgt_instance_type

string

Fgt instance type.

Choices:

  • "t2.small"

  • "c5.large"

  • "c5.xlarge"

  • "c5.2xlarge"

  • "c5.4xlarge"

  • "c5.9xlarge"

fgt_psk_secret

string

Fgt psk secret.

fgtasg_cool_down

integer

Fgtasg cool down.

fgtasg_desired_capacity_byol

integer

Fgtasg desired capacity byol.

fgtasg_desired_capacity_payg

integer

Fgtasg desired capacity payg.

fgtasg_health_check_grace_period

integer

Fgtasg health check grace period.

fgtasg_max_size_byol

integer

Fgtasg max size byol.

fgtasg_max_size_payg

integer

Fgtasg max size payg.

fgtasg_min_size_byol

integer

Fgtasg min size byol.

fgtasg_min_size_payg

integer

Fgtasg min size payg.

fgtasg_scale_in_threshold

integer

Fgtasg scale in threshold.

fgtasg_scale_out_threshold

integer

Fgtasg scale out threshold.

fos_version

string

Fos version.

get_license_grace_period

integer

Get license grace period.

heartbeat_delay_allowance

integer

Heartbeat delay allowance.

heartbeat_interval

integer

Heartbeat interval.

heartbeat_loss_count

integer

Heartbeat loss count.

internal_balancer_dns_name

string

Internal balancer dns name.

internal_balancing_options

string

Internal balancing options.

Choices:

  • "add a new internal load balancer"

  • "use a load balancer specified below"

  • "do not need one"

internal_target_group_health_check_path

string

Internal target group health check path.

key_pair_name

string

Key pair name.

lifecycle_hook_timeout

integer

Lifecycle hook timeout.

loadbalancing_health_check_threshold

integer

Loadbalancing health check threshold.

loadbalancing_traffic_port

integer

Loadbalancing traffic port.

loadbalancing_traffic_protocol

string

Loadbalancing traffic protocol.

Choices:

  • "HTTPS"

  • "HTTP"

  • "TCP"

name

string / required

Name.

notification_email

string

Notification email.

primary_election_timeout

integer

Primary election timeout.

private_subnet1_cidr

string

Private subnet1 cidr.

private_subnet2_cidr

string

Private subnet2 cidr.

public_subnet1_cidr

string

Public subnet1 cidr.

public_subnet2_cidr

string

Public subnet2 cidr.

resource_tag_prefix

string

Resource tag prefix.

s3_bucket_name

string

S3 bucket name.

s3_key_prefix

string

S3 key prefix.

sync_recovery_count

integer

Sync recovery count.

terminate_unhealthy_vm

string

Terminate unhealthy vm.

Choices:

  • "no"

  • "yes"

use_custom_asset_location

string

Use custom asset location.

Choices:

  • "no"

  • "yes"

vpc_cidr

string

Vpc cidr.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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: Cloud orchest awstemplate autoscale new vpc
      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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)