fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc module – Cloud orchest awstemplate autoscale tgw new vpc

Note

This module is part of the fortinet.fortimanager collection (version 2.7.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_autoscaletgwnewvpc.

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_autoscaletgwnewvpc

dictionary

The top level parameters set.

availability-zones

string

Deprecated, please rename it to availability_zones. Availability zones.

bgp-asn

integer

Deprecated, please rename it to bgp_asn. Bgp asn.

custom-asset-container

string

Deprecated, please rename it to custom_asset_container. Custom asset container.

custom-asset-directory

string

Deprecated, please rename it to custom_asset_directory. Custom asset directory.

custom-identifier

string

Deprecated, please rename it to custom_identifier. Custom identifier.

faz-autoscale-admin-password

any

(list) Deprecated, please rename it to faz_autoscale_admin_password. Faz autoscale admin password.

faz-autoscale-admin-username

string

Deprecated, please rename it to faz_autoscale_admin_username. Faz autoscale admin username.

faz-custom-private-ipaddress

string

Deprecated, please rename it to faz_custom_private_ipaddress. Faz custom private ipaddress.

faz-instance-type

string

Deprecated, please rename it to faz_instance_type. 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

Deprecated, please rename it to faz_integration_options. Faz integration options.

Choices:

  • "no"

  • "yes"

faz-version

string

Deprecated, please rename it to faz_version. Faz version.

fgt-admin-cidr

string

Deprecated, please rename it to fgt_admin_cidr. Fgt admin cidr.

fgt-admin-port

integer

Deprecated, please rename it to fgt_admin_port. Fgt admin port.

fgt-instance-type

string

Deprecated, please rename it to fgt_instance_type. Fgt instance type.

Choices:

  • "t2.small"

  • "c5.large"

  • "c5.xlarge"

  • "c5.2xlarge"

  • "c5.4xlarge"

  • "c5.9xlarge"

fgt-psk-secret

string

Deprecated, please rename it to fgt_psk_secret. Fgt psk secret.

fgtasg-cool-down

integer

Deprecated, please rename it to fgtasg_cool_down. Fgtasg cool down.

fgtasg-desired-capacity-byol

integer

Deprecated, please rename it to fgtasg_desired_capacity_byol. Fgtasg desired capacity byol.

fgtasg-desired-capacity-payg

integer

Deprecated, please rename it to fgtasg_desired_capacity_payg. Fgtasg desired capacity payg.

fgtasg-health-check-grace-period

integer

Deprecated, please rename it to fgtasg_health_check_grace_period. Fgtasg health check grace period.

fgtasg-max-size-byol

integer

Deprecated, please rename it to fgtasg_max_size_byol. Fgtasg max size byol.

fgtasg-max-size-payg

integer

Deprecated, please rename it to fgtasg_max_size_payg. Fgtasg max size payg.

fgtasg-min-size-byol

integer

Deprecated, please rename it to fgtasg_min_size_byol. Fgtasg min size byol.

fgtasg-min-size-payg

integer

Deprecated, please rename it to fgtasg_min_size_payg. Fgtasg min size payg.

fgtasg-scale-in-threshold

integer

Deprecated, please rename it to fgtasg_scale_in_threshold. Fgtasg scale in threshold.

fgtasg-scale-out-threshold

integer

Deprecated, please rename it to fgtasg_scale_out_threshold. Fgtasg scale out threshold.

fos-version

string

Deprecated, please rename it to fos_version. Fos version.

get-license-grace-period

integer

Deprecated, please rename it to get_license_grace_period. Get license grace period.

heartbeat-delay-allowance

integer

Deprecated, please rename it to heartbeat_delay_allowance. Heartbeat delay allowance.

heartbeat-interval

integer

Deprecated, please rename it to heartbeat_interval. Heartbeat interval.

heartbeat-loss-count

integer

Deprecated, please rename it to heartbeat_loss_count. Heartbeat loss count.

key-pair-name

string

Deprecated, please rename it to key_pair_name. Key pair name.

lifecycle-hook-timeout

integer

Deprecated, please rename it to lifecycle_hook_timeout. Lifecycle hook timeout.

name

string / required

Name.

notification-email

string

Deprecated, please rename it to notification_email. Notification email.

primary-election-timeout

integer

Deprecated, please rename it to primary_election_timeout. Primary election timeout.

public-subnet1-cidr

string

Deprecated, please rename it to public_subnet1_cidr. Public subnet1 cidr.

public-subnet2-cidr

string

Deprecated, please rename it to public_subnet2_cidr. Public subnet2 cidr.

resource-tag-prefix

string

Deprecated, please rename it to resource_tag_prefix. Resource tag prefix.

s3-bucket-name

string

Deprecated, please rename it to s3_bucket_name. S3 bucket name.

s3-key-prefix

string

Deprecated, please rename it to s3_key_prefix. S3 key prefix.

sync-recovery-count

integer

Deprecated, please rename it to sync_recovery_count. Sync recovery count.

terminate-unhealthy-vm

string

Deprecated, please rename it to terminate_unhealthy_vm. Terminate unhealthy vm.

Choices:

  • "no"

  • "yes"

transit-gateway-id

string

Deprecated, please rename it to transit_gateway_id. Transit gateway id.

transit-gateway-support-options

string

Deprecated, please rename it to transit_gateway_support_options. Transit gateway support options.

Choices:

  • "create one"

  • "use an existing one"

use-custom-asset-location

string

Deprecated, please rename it to use_custom_asset_location. Use custom asset location.

Choices:

  • "no"

  • "yes"

vpc-cidr

string

Deprecated, please rename it to vpc_cidr. 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 tgw new vpc
      fortinet.fortimanager.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: present # <value in [present, absent]>
        cloud_orchestawstemplate_autoscaletgwnewvpc:
          availability_zones: <string>
          bgp_asn: <integer>
          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>
          key_pair_name: <string>
          lifecycle_hook_timeout: <integer>
          name: <string>
          notification_email: <string>
          primary_election_timeout: <integer>
          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]>
          transit_gateway_id: <string>
          transit_gateway_support_options: <value in [create one, use an existing one]>
          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)