community.network.ftd_install 模块 – 在防火墙上安装 FTD pkg 镜像

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.network。您需要更多要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：community.network.ftd_install。

注意

community.network 集合已被弃用，将从 Ansible 12 中删除。有关详细信息，请参阅讨论主题。

已弃用 

在以下版本中删除:: 版本 6.0.0
原因:: 此集合及其中的所有内容均未维护且已弃用。
替代方案:: 未知。

概要 

FTD 设备的配置模块，用于在防火墙上安装 ROMMON 镜像（如果需要）和 FTD pkg 镜像。
可以与 `httpapi` 和 `local` 连接类型一起使用。首选 `httpapi`，只有当无法通过 REST API 访问设备时才应使用 `local` 连接。

别名：network.ftd.ftd_install

要求 

执行此模块的主机需要以下要求。

python >= 3.5
firepower-kickstart

参数 

参数	注释
console_ip 字符串 / 必需	终端服务器的 IP 地址。用于通过终端服务器与设备的控制台端口建立 SSH 连接。
console_password 字符串 / 必需	登录终端服务器的密码。
console_port 字符串 / 必需	设备在终端服务器上的端口。
console_username 字符串 / 必需	登录终端服务器的用户名。
device_gateway 字符串	管理接口的设备网关。如果未指定且连接为 “httpapi”，则模块会尝试通过 REST API 获取现有值。对于 “local” 连接类型，此参数是强制性的。
device_hostname 字符串 / 必需	设备的主机名，如提示符中所示（例如，“firepower-5516”）。
device_ip 字符串	管理接口的设备 IP 地址。如果未指定且连接为 “httpapi”，则模块会尝试通过 REST API 获取现有值。对于 “local” 连接类型，此参数是强制性的。
device_model 字符串	设备的平台型号（例如，“Cisco ASA5506-X Threat Defense”）。如果未指定且连接为 “httpapi”，则模块会尝试通过 REST API 获取设备型号。对于 “local” 连接类型，此参数是强制性的。选择 `"Cisco ASA5506-X Threat Defense"` `"Cisco ASA5508-X Threat Defense"` `"Cisco ASA5516-X Threat Defense"` `"Cisco Firepower 2110 Threat Defense"` `"Cisco Firepower 2120 Threat Defense"` `"Cisco Firepower 2130 Threat Defense"` `"Cisco Firepower 2140 Threat Defense"`
device_netmask 字符串	管理接口的设备子网掩码。如果未指定且连接为 “httpapi”，则模块会尝试通过 REST API 获取现有值。对于 “local” 连接类型，此参数是强制性的。
device_new_password 字符串	镜像安装后要设置的新设备密码。如果未指定，则会重用 `device_password` 属性中的当前密码。不适用于 ASA5500-X 系列设备。
device_password 字符串 / 必需	登录设备的密码。
device_sudo_password 字符串	设备的 root 密码。如果未指定，则使用 `device_password`。
device_username 字符串	登录设备的用户名。如果未指定，则默认为“admin”。默认值： `"admin"`
dns_server 字符串	管理接口的 DNS IP 地址。如果未指定且连接为 “httpapi”，则模块会尝试通过 REST API 获取现有值。对于 “local” 连接类型，此参数是强制性的。
force_install 布尔值	强制安装 FTD 镜像，即使防火墙上已经安装了相同的版本。默认情况下，当目标版本已安装在设备中时，模块会停止执行。选择 `false` ←（默认） `true`
image_file_location 字符串 / 必需	服务器上要下载的 FTD pkg 镜像的路径。通常支持 FTP、SCP、SFTP、TFTP 或 HTTP 协议，但可能取决于设备型号。
image_version 字符串 / 必需	要安装的 FTD 镜像的版本。有助于比较目标和当前的 FTD 版本，以防止不必要的重新安装。
rommon_file_location 字符串 / 必需	TFTP 服务器上引导 (ROMMON) 镜像的路径。仅支持 TFTP。
search_domains 字符串	以逗号分隔的搜索域。如果未指定，则默认为 “cisco.com”。默认值： `"cisco.com"`

注释 

注意

需要单独安装的 `firepower-kickstart` 库，并且需要 Python >= 3.5。
在 localhost 上，Ansible 仍然可以使用 Python >= 2.7 运行，但此特定模块的解释器必须是 Python >= 3.5。
可以在 `ansible_python_interpreter` 变量中覆盖模块的 Python 解释器。

示例 

- name: Install image v6.3.0 on FTD 5516
  community.network.ftd_install:
    device_hostname: firepower
    device_password: pass
    device_ip: 192.168.0.1
    device_netmask: 255.255.255.0
    device_gateway: 192.168.0.254
    dns_server: 8.8.8.8

    console_ip: 10.89.0.0
    console_port: 2004
    console_username: console_user
    console_password: console_pass

    rommon_file_location: 'tftp://10.89.0.11/installers/ftd-boot-9.10.1.3.lfbff'
    image_file_location: 'https://10.89.0.11/installers/ftd-6.3.0-83.pkg'
    image_version: 6.3.0-83

返回值 

常见的返回值记录在这里，以下是此模块特有的字段

键	描述
msg 字符串	说明镜像是否安装成功或解释安装失败原因的消息。返回: 总是

community.network.ftd_install 模块 – 在防火墙上安装 FTD pkg 镜像

已弃用 

概要 

要求 

参数 

注释 

示例 

返回值 

状态 

作者

集合链接