fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc 模块 – 云编排 awstemplate 自动扩展 tgw 新建 vpc

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc。

fortinet.fortimanager 2.2.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括在使用前需要调整为数据源的所有参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

cloud_orchestawstemplate_autoscaletgwnewvpc

字典

顶层参数集。

availability_zones

别名: availability-zones

字符串

可用区。

bgp_asn

别名: bgp-asn

整数

Bgp asn。

custom_asset_container

别名: custom-asset-container

字符串

自定义资产容器。

custom_asset_directory

别名: custom-asset-directory

字符串

自定义资产目录。

custom_identifier

别名: custom-identifier

字符串

自定义标识符。

faz_autoscale_admin_password

别名: faz-autoscale-admin-password

任何

(列表) Faz 自动扩展管理员密码。

faz_autoscale_admin_username

别名: faz-autoscale-admin-username

字符串

Faz 自动扩展管理员用户名。

faz_custom_private_ipaddress

别名: faz-custom-private-ipaddress

字符串

Faz 自定义私有 IP 地址。

faz_instance_type

别名: faz-instance-type

字符串

Faz 实例类型。

选项

  • "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

别名: faz-integration-options

字符串

Faz 集成选项。

选项

  • "no"

  • "yes"

faz_version

别名: faz-version

字符串

Faz 版本。

fgt_admin_cidr

别名: fgt-admin-cidr

字符串

Fgt 管理 CIDR。

fgt_admin_port

别名: fgt-admin-port

整数

Fgt 管理端口。

fgt_instance_type

别名: fgt-instance-type

字符串

Fgt 实例类型。

选项

  • "t2.small"

  • "c5.large"

  • "c5.xlarge"

  • "c5.2xlarge"

  • "c5.4xlarge"

  • "c5.9xlarge"

fgt_psk_secret

别名: fgt-psk-secret

字符串

Fgt psk 密钥。

fgtasg_cool_down

别名: fgtasg-cool-down

整数

Fgtasg 冷却时间。

fgtasg_desired_capacity_byol

别名：fgtasg-desired-capacity-byol

整数

Fgtasg BYOL 期望容量。

fgtasg_desired_capacity_payg

别名：fgtasg-desired-capacity-payg

整数

Fgtasg PAYG 期望容量。

fgtasg_health_check_grace_period

别名：fgtasg-health-check-grace-period

整数

Fgtasg 健康检查宽限期。

fgtasg_max_size_byol

别名：fgtasg-max-size-byol

整数

Fgtasg BYOL 最大容量。

fgtasg_max_size_payg

别名：fgtasg-max-size-payg

整数

Fgtasg PAYG 最大容量。

fgtasg_min_size_byol

别名：fgtasg-min-size-byol

整数

Fgtasg BYOL 最小容量。

fgtasg_min_size_payg

别名：fgtasg-min-size-payg

整数

Fgtasg PAYG 最小容量。

fgtasg_scale_in_threshold

别名：fgtasg-scale-in-threshold

整数

Fgtasg 缩减阈值。

fgtasg_scale_out_threshold

别名：fgtasg-scale-out-threshold

整数

Fgtasg 扩展阈值。

fos_version

别名：fos-version

字符串

FOS 版本。

get_license_grace_period

别名：get-license-grace-period

整数

获取许可证宽限期。

heartbeat_delay_allowance

别名：heartbeat-delay-allowance

整数

心跳延迟允许值。

heartbeat_interval

别名：heartbeat-interval

整数

心跳间隔。

heartbeat_loss_count

别名：heartbeat-loss-count

整数

心跳丢失计数。

key_pair_name

别名：key-pair-name

字符串

密钥对名称。

lifecycle_hook_timeout

别名：lifecycle-hook-timeout

整数

生命周期钩子超时。

name

字符串 / 必需

名称。

notification_email

别名：notification-email

字符串

通知电子邮件。

primary_election_timeout

别名：primary-election-timeout

整数

主节点选举超时。

public_subnet1_cidr

别名：public-subnet1-cidr

字符串

公共子网 1 CIDR。

public_subnet2_cidr

别名：public-subnet2-cidr

字符串

公共子网 2 CIDR。

resource_tag_prefix

别名：resource-tag-prefix

字符串

资源标签前缀。

s3_bucket_name

别名：s3-bucket-name

字符串

S3 存储桶名称。

s3_key_prefix

别名：s3-key-prefix

字符串

S3 密钥前缀。

sync_recovery_count

别名：sync-recovery-count

整数

同步恢复计数。

terminate_unhealthy_vm

别名：terminate-unhealthy-vm

字符串

终止不健康的虚拟机。

选项

  • "no"

  • "yes"

transit_gateway_id

别名：transit-gateway-id

字符串

传输网关 ID。

transit_gateway_support_options

别名：transit-gateway-support-options

字符串

传输网关支持选项。

选项

  • "创建 一个"

  • "使用 现有的 一个"

use_custom_asset_location

别名：use-custom-asset-location

字符串

使用自定义资产位置。

选项

  • "no"

  • "yes"

vpc_cidr

别名：vpc-cidr

字符串

VPC CIDR。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

list / elements=integer

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最长时间（以秒为单位）。

默认值： 300

说明

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如 “var-name” 之类的参数更改为 “var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可以帮助完成此项工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- 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>

返回值

常见返回值在此处 记录，以下是此模块独有的字段

键

描述

meta

字典

请求的结果。

返回： 始终

request_url

字符串

请求的完整 URL。

返回： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回： 始终

示例： 0

response_data

list / elements=string

API 响应。

返回： 始终

response_message

字符串

API 响应的描述性消息。

返回： 始终

示例： "OK."

system_information

字典

目标系统的信息。

返回： 始终

rc

整数

请求的状态。

返回： 始终

示例： 0

version_check_warning

list / elements=string

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)